vrl 0.32.0

Vector Remap Language
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

use crate::compiler::prelude::*;
use bytes::Bytes;

fn uuid_from_friendly_id(value: &Value) -> Resolved {
    let mut buf = [0; 36];
    let value = value.try_bytes_utf8_lossy()?;
    match base62::decode(value.as_ref()) {
        Err(err) => Err(format!("failed to decode friendly id: {err}").into()),
        Ok(w128) => {
            let uuid = uuid::Uuid::from_u128(w128)
                .hyphenated()
                .encode_lower(&mut buf);
            Ok(Bytes::copy_from_slice(uuid.as_bytes()).into())
        }
    }
}

#[derive(Clone, Copy, Debug)]
pub struct UuidFromFriendlyId;

impl Function for UuidFromFriendlyId {
    fn identifier(&self) -> &'static str {
        "uuid_from_friendly_id"
    }

    fn usage(&self) -> &'static str {
        "Convert a Friendly ID (base62 encoding a 128-bit word) to a UUID."
    }

    fn category(&self) -> &'static str {
        Category::Random.as_ref()
    }

    fn internal_failure_reasons(&self) -> &'static [&'static str] {
        &[
            "`value` is a string but the text uses characters outside of class [0-9A-Za-z].",
            "`value` is a base62 encoding of an integer, but the integer is greater than or equal to 2^128.",
        ]
    }

    fn return_kind(&self) -> u16 {
        kind::BYTES
    }

    fn parameters(&self) -> &'static [Parameter] {
        const PARAMETERS: &[Parameter] = &[Parameter::required(
            "value",
            kind::BYTES,
            "A string that is a Friendly ID",
        )];
        PARAMETERS
    }

    fn examples(&self) -> &'static [Example] {
        &[example! {
            title: "Convert a Friendly ID to a UUID",
            source: r#"uuid_from_friendly_id!("3s87yEvnmkiPBMHsj8bwwc")"#,
            result: Ok("7f41deed-d5e2-8b5e-7a13-ab4ff93cfad2"),
        }]
    }

    fn compile(
        &self,
        _state: &state::TypeState,
        _ctx: &mut FunctionCompileContext,
        arguments: ArgumentList,
    ) -> Compiled {
        let value = arguments.required("value");
        Ok(UuidFromFriendlyIdFn { value }.as_expr())
    }
}

#[derive(Debug, Clone)]
struct UuidFromFriendlyIdFn {
    value: Box<dyn Expression>,
}

impl FunctionExpression for UuidFromFriendlyIdFn {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        let value = self.value.resolve(ctx)?;
        uuid_from_friendly_id(&value)
    }

    fn type_def(&self, _: &TypeState) -> TypeDef {
        TypeDef::bytes().fallible()
    }
}

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

    test_function![
        uuid_from_friendly_id => UuidFromFriendlyId;
        example_from_docs {
            args: func_args![value: value!("3s87yEvnmkiPBMHsj8bwwc")],
            want: Ok(value!("7f41deed-d5e2-8b5e-7a13-ab4ff93cfad2")),
            tdef: TypeDef::bytes().fallible(),
        }
    ];
}