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

use std::collections::BTreeMap;
use std::ops::{Deref, DerefMut};
use vrl::diagnostic::Label;
use vrl::path::{OwnedTargetPath, PathPrefix};
use vrl::prelude::*;

#[derive(Debug, Default, Clone)]
pub struct MeaningList(pub BTreeMap<String, OwnedTargetPath>);

impl Deref for MeaningList {
    type Target = BTreeMap<String, OwnedTargetPath>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for MeaningList {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

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

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

    fn parameters(&self) -> &'static [Parameter] {
        &[
            Parameter {
                keyword: "target",
                kind: kind::ANY,
                required: true,
            },
            Parameter {
                keyword: "meaning",
                kind: kind::BYTES,
                required: true,
            },
        ]
    }

    fn examples(&self) -> &'static [Example] {
        &[Example {
            title: "Sets custom field semantic meaning",
            source: r#"set_semantic_meaning(.foo, "bar")"#,
            result: Ok("null"),
        }]
    }

    fn compile(
        &self,
        state: &TypeState,
        ctx: &mut FunctionCompileContext,
        arguments: ArgumentList,
    ) -> Compiled {
        let span = ctx.span();
        let query = arguments.required_query("target")?;

        let meaning = arguments
            .required_literal("meaning", state)?
            .try_bytes_utf8_lossy()
            .expect("meaning not bytes")
            .into_owned();

        let path = if let Some(path) = query.external_path() {
            path
        } else {
            // Semantic meaning can only be assigned to external fields.
            let mut labels = vec![Label::primary(
                "this path must point to an event or metadata",
                span,
            )];

            if let Some(variable) = query.as_variable() {
                labels.push(Label::context(
                    format!(
                        "maybe you meant \".{}\" or \"%{}\"?",
                        variable.ident(),
                        variable.ident()
                    ),
                    span,
                ));
            }

            let error = ExpressionError::Error {
                message: "semantic meaning is not valid for local variables".to_owned(),
                labels,
                notes: vec![],
            };

            return Err(Box::new(error) as Box<dyn DiagnosticMessage>);
        };

        let exists = match path.prefix {
            PathPrefix::Event => state.external.target_kind(),
            PathPrefix::Metadata => state.external.metadata_kind(),
        }
        .at_path(&path.path)
        .contains_any_defined();

        // Reject assigning meaning to non-existing field.
        if !exists {
            let error = ExpressionError::Error {
                message: "semantic meaning defined for non-existing field".to_owned(),
                labels: vec![
                    Label::primary("cannot assign semantic meaning to non-existing field", span),
                    Label::context(
                        format!("field \".{}\" is not known to exist for all events", &path),
                        span,
                    ),
                ],
                notes: vec![],
            };

            return Err(Box::new(error) as Box<dyn DiagnosticMessage>);
        }

        if let Some(list) = ctx.get_external_context_mut::<MeaningList>() {
            let duplicate = list.get(&meaning).filter(|&p| p != &path);

            // Disallow a single VRL program from assigning the same semantic meaning to two
            // different fields.
            if let Some(duplicate) = duplicate {
                let error = ExpressionError::Error {
                    message: "semantic meaning referencing two different fields".to_owned(),
                    labels: vec![
                        Label::primary(
                            format!(
                                "semantic meaning \"{}\" must reference a single field",
                                &meaning
                            ),
                            span,
                        ),
                        Label::context(
                            format!("already referencing field \".{}\"", &duplicate),
                            span,
                        ),
                    ],
                    notes: vec![],
                };

                return Err(Box::new(error) as Box<dyn DiagnosticMessage>);
            }

            list.insert(meaning, path);
        };

        Ok(SetSemanticMeaningFn.as_expr())
    }
}

#[derive(Debug, Clone)]
struct SetSemanticMeaningFn;

impl FunctionExpression for SetSemanticMeaningFn {
    fn resolve(&self, _ctx: &mut Context) -> Resolved {
        Ok(Value::Null)
    }

    fn type_def(&self, _: &TypeState) -> TypeDef {
        TypeDef::null().infallible().impure()
    }
}