flow/expr/
error.rs

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
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Error handling for expression evaluation.

use std::any::Any;

use arrow_schema::ArrowError;
use common_error::ext::{BoxedError, ErrorExt};
use common_error::status_code::StatusCode;
use common_macro::stack_trace_debug;
use datafusion_common::DataFusionError;
use datatypes::data_type::ConcreteDataType;
use snafu::{Location, Snafu};

/// EvalError is about errors happen on columnar evaluation
///
/// TODO(discord9): add detailed location of column/operator(instead of code) to errors tp help identify related column
#[derive(Snafu)]
#[snafu(visibility(pub))]
#[stack_trace_debug]
pub enum EvalError {
    #[snafu(display("Division by zero"))]
    DivisionByZero {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Type mismatch: expected {expected}, actual {actual}"))]
    TypeMismatch {
        expected: ConcreteDataType,
        actual: ConcreteDataType,
        #[snafu(implicit)]
        location: Location,
    },

    /// can't nest datatypes error because EvalError need to be store in map and serialization
    #[snafu(display("Fail to unpack from value to given type: {msg}"))]
    TryFromValue {
        msg: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Fail to cast value of type {from} to given type {to}"))]
    CastValue {
        from: ConcreteDataType,
        to: ConcreteDataType,
        source: datatypes::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("{msg}"))]
    DataType {
        msg: String,
        source: datatypes::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Invalid argument: {reason}"))]
    InvalidArgument {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Internal error: {reason}"))]
    Internal {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Optimize error: {reason}"))]
    Optimize {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Overflowed during evaluation"))]
    Overflow {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Incoming data already expired by {} ms", expired_by))]
    DataAlreadyExpired {
        expired_by: i64,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Arrow error: {error:?}, context: {context}"))]
    Arrow {
        #[snafu(source)]
        error: ArrowError,
        context: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("DataFusion error: {error:?}, context: {context}"))]
    Datafusion {
        #[snafu(source)]
        error: DataFusionError,
        context: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("External error"))]
    External {
        #[snafu(implicit)]
        location: Location,
        source: BoxedError,
    },
}

impl ErrorExt for EvalError {
    fn status_code(&self) -> StatusCode {
        use EvalError::*;
        match self {
            DivisionByZero { .. }
            | TypeMismatch { .. }
            | TryFromValue { .. }
            | DataAlreadyExpired { .. }
            | InvalidArgument { .. }
            | Overflow { .. } => StatusCode::InvalidArguments,

            CastValue { source, .. } | DataType { source, .. } => source.status_code(),

            Internal { .. }
            | Optimize { .. }
            | Arrow { .. }
            | Datafusion { .. }
            | External { .. } => StatusCode::Internal,
        }
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}