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
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

use crate::compiler::prelude::*;
use rand::Rng;
use std::ops::Range;

const INVALID_RANGE_ERR: &str = "max must be greater than min";

fn random_int(min: Value, max: Value) -> Resolved {
    let range = get_range(min, max)?;

    let i: i64 = rand::rng().random_range(range);

    Ok(Value::Integer(i))
}

fn get_range(min: Value, max: Value) -> std::result::Result<Range<i64>, &'static str> {
    let min = min.try_integer().expect("min must be an integer");
    let max = max.try_integer().expect("max must be an integer");

    if max <= min {
        return Err(INVALID_RANGE_ERR);
    }

    Ok(min..max)
}

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

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

    fn usage(&self) -> &'static str {
        "Returns a random integer between [min, max)."
    }

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

    fn internal_failure_reasons(&self) -> &'static [&'static str] {
        &["`max` is not greater than `min`."]
    }

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

    fn parameters(&self) -> &'static [Parameter] {
        const PARAMETERS: &[Parameter] = &[
            Parameter::required("min", kind::INTEGER, "Minimum value (inclusive)."),
            Parameter::required("max", kind::INTEGER, "Maximum value (exclusive)."),
        ];
        PARAMETERS
    }

    fn examples(&self) -> &'static [Example] {
        &[example! {
            title: "Random integer from 0 to 10, not including 10",
            source: indoc! {"
                i = random_int(0, 10)
                i >= 0 && i < 10
            "},
            result: Ok("true"),
        }]
    }

    fn compile(
        &self,
        state: &state::TypeState,
        _ctx: &mut FunctionCompileContext,
        arguments: ArgumentList,
    ) -> Compiled {
        let min = arguments.required("min");
        let max = arguments.required("max");

        if let (Some(min), Some(max)) = (min.resolve_constant(state), max.resolve_constant(state)) {
            // check if range is valid
            let _: Range<i64> =
                get_range(min, max.clone()).map_err(|err| function::Error::InvalidArgument {
                    keyword: "max",
                    value: max,
                    error: err,
                })?;
        }

        Ok(RandomIntFn { min, max }.as_expr())
    }
}

#[derive(Debug, Clone)]
struct RandomIntFn {
    min: Box<dyn Expression>,
    max: Box<dyn Expression>,
}

impl FunctionExpression for RandomIntFn {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        let min = self.min.resolve(ctx)?;
        let max = self.max.resolve(ctx)?;

        random_int(min, max)
    }

    fn type_def(&self, state: &state::TypeState) -> TypeDef {
        match (
            self.min.resolve_constant(state),
            self.max.resolve_constant(state),
        ) {
            (Some(min), Some(max)) => {
                if get_range(min, max).is_ok() {
                    TypeDef::integer()
                } else {
                    TypeDef::integer().fallible()
                }
            }
            _ => TypeDef::integer().fallible(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::value;
    // positive tests are handled by examples

    test_function![
        random_int => RandomInt;

        bad_range {
            args: func_args![min: value!(1), max: value!(1)],
            want: Err("invalid argument"),
            tdef: TypeDef::integer().fallible(),
        }
    ];
}