common_recordbatch/

error.rs

// 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 of record batch.
use std::any::Any;

use common_error::ext::{BoxedError, ErrorExt, RetryHint};
use common_error::status_code::StatusCode;
use common_macro::stack_trace_debug;
use datafusion_common::ScalarValue;
use datatypes::prelude::ConcreteDataType;
use datatypes::schema::SchemaRef;
use snafu::{Location, Snafu};

pub type Result<T, E = Error> = std::result::Result<T, E>;

#[derive(Snafu)]
#[snafu(visibility(pub))]
#[stack_trace_debug]
pub enum Error {
    #[snafu(display("Fail to create datafusion record batch"))]
    NewDfRecordBatch {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Data types error"))]
    DataTypes {
        #[snafu(implicit)]
        location: Location,
        source: datatypes::error::Error,
    },

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

    #[snafu(display("Failed to create RecordBatches, reason: {}", reason))]
    CreateRecordBatches {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to convert Arrow schema"))]
    SchemaConversion {
        source: datatypes::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(transparent)]
    PollStream {
        #[snafu(source)]
        error: datafusion::error::DataFusionError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Create physical expr error"))]
    PhysicalExpr {
        #[snafu(source)]
        error: datafusion::error::DataFusionError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Fail to format record batch"))]
    Format {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to convert {v:?} to Arrow scalar"))]
    ToArrowScalar {
        v: ScalarValue,
        #[snafu(source)]
        error: datafusion_common::DataFusionError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Failed to project Arrow RecordBatch with schema {:?} and projection {:?}",
        schema,
        projection,
    ))]
    ProjectArrowRecordBatch {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
        schema: datatypes::schema::SchemaRef,
        projection: Vec<usize>,
    },

    #[snafu(display("Column {} not exists in table {}", column_name, table_name))]
    ColumnNotExists {
        column_name: String,
        table_name: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Failed to cast vector of type '{:?}' to type '{:?}'",
        from_type,
        to_type,
    ))]
    CastVector {
        from_type: ConcreteDataType,
        to_type: ConcreteDataType,
        #[snafu(implicit)]
        location: Location,
        source: datatypes::error::Error,
    },

    #[snafu(display("Error occurs when performing arrow computation"))]
    ArrowCompute {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Unsupported operation: {}", reason))]
    UnsupportedOperation {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Cannot construct an empty stream"))]
    EmptyStream {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Schema not match, left: {:?}, right: {:?}", left, right))]
    SchemaNotMatch {
        left: SchemaRef,
        right: SchemaRef,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Stream timeout"))]
    StreamTimeout {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("RecordBatch slice index overflow: {visit_index} > {size}"))]
    RecordBatchSliceIndexOverflow {
        #[snafu(implicit)]
        location: Location,
        size: usize,
        visit_index: usize,
    },

    #[snafu(display("Stream has been cancelled"))]
    StreamCancelled {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Exceeded memory limit: {}", msg))]
    ExceedMemoryLimit {
        msg: String,
        #[snafu(implicit)]
        location: Location,
    },
}

impl ErrorExt for Error {
    fn status_code(&self) -> StatusCode {
        match self {
            Error::NewDfRecordBatch { .. }
            | Error::EmptyStream { .. }
            | Error::SchemaNotMatch { .. } => StatusCode::InvalidArguments,

            Error::DataTypes { .. }
            | Error::CreateRecordBatches { .. }
            | Error::Format { .. }
            | Error::ToArrowScalar { .. }
            | Error::ProjectArrowRecordBatch { .. }
            | Error::PhysicalExpr { .. }
            | Error::RecordBatchSliceIndexOverflow { .. } => StatusCode::Internal,

            Error::PollStream { error, .. } => {
                let mut error = error;
                loop {
                    error = match error {
                        datafusion::error::DataFusionError::Shared(inner) => inner,
                        datafusion::error::DataFusionError::Context(_, inner)
                        | datafusion::error::DataFusionError::Diagnostic(_, inner) => inner,
                        _ => break,
                    };
                }

                match error {
                    datafusion::error::DataFusionError::External(source) => source
                        .downcast_ref::<BoxedError>()
                        .map_or(StatusCode::EngineExecuteQuery, |source| {
                            source.status_code()
                        }),
                    _ => StatusCode::EngineExecuteQuery,
                }
            }

            Error::ArrowCompute { .. } => StatusCode::IllegalState,

            Error::ColumnNotExists { .. } => StatusCode::TableColumnNotFound,

            Error::External { source, .. } => source.status_code(),

            Error::UnsupportedOperation { .. } => StatusCode::Unsupported,

            Error::SchemaConversion { source, .. } | Error::CastVector { source, .. } => {
                source.status_code()
            }

            Error::StreamTimeout { .. } => StatusCode::Cancelled,

            Error::StreamCancelled { .. } => StatusCode::Cancelled,

            Error::ExceedMemoryLimit { .. } => StatusCode::RuntimeResourcesExhausted,
        }
    }

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

    fn retry_hint(&self) -> RetryHint {
        match self {
            Error::ExceedMemoryLimit { .. } => RetryHint::Retryable,
            Error::External { source, .. } => source.retry_hint(),
            Error::SchemaConversion { source, .. } | Error::CastVector { source, .. } => {
                source.retry_hint()
            }
            _ => RetryHint::NonRetryable,
        }
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use common_error::ext::PlainError;
    use datafusion::error::DataFusionError;

    use super::*;

    #[test]
    fn poll_stream_status_code_preserves_boxed_error_through_wrappers() {
        let boxed_error = |status| {
            DataFusionError::External(Box::new(BoxedError::new(PlainError::new(
                "neutral error".to_string(),
                status,
            ))))
        };

        for status in [
            StatusCode::RequestOutdated,
            StatusCode::Unknown,
            StatusCode::Unsupported,
        ] {
            let errors = [
                boxed_error(status),
                DataFusionError::Shared(Arc::new(boxed_error(status))),
                DataFusionError::Context("context".to_string(), Box::new(boxed_error(status))),
                DataFusionError::Diagnostic(
                    Box::new(datafusion::common::Diagnostic::new_error(
                        "diagnostic",
                        None,
                    )),
                    Box::new(boxed_error(status)),
                ),
                DataFusionError::Shared(Arc::new(DataFusionError::Context(
                    "context".to_string(),
                    Box::new(DataFusionError::Diagnostic(
                        Box::new(datafusion::common::Diagnostic::new_error(
                            "diagnostic",
                            None,
                        )),
                        Box::new(boxed_error(status)),
                    )),
                ))),
            ];

            for error in errors {
                let error = Error::PollStream {
                    error,
                    location: Location::default(),
                };
                assert_eq!(error.status_code(), status);
            }
        }

        let error = Error::PollStream {
            error: DataFusionError::Shared(Arc::new(DataFusionError::External(Box::new(
                BoxedError::new(Error::PhysicalExpr {
                    error: DataFusionError::NotImplemented("inner error".to_string()),
                    location: Location::default(),
                }),
            )))),
            location: Location::default(),
        };
        assert_eq!(error.status_code(), StatusCode::Internal);
    }

    #[test]
    fn poll_stream_status_code_defaults_for_other_datafusion_errors() {
        let wrap = |error| {
            DataFusionError::Shared(Arc::new(DataFusionError::Context(
                "context".to_string(),
                Box::new(DataFusionError::Diagnostic(
                    Box::new(datafusion::common::Diagnostic::new_error(
                        "diagnostic",
                        None,
                    )),
                    Box::new(error),
                )),
            )))
        };
        let errors = || {
            [
                DataFusionError::External(Box::new(std::io::Error::other("neutral io error"))),
                DataFusionError::Internal("neutral internal error".to_string()),
                DataFusionError::NotImplemented("neutral not implemented error".to_string()),
                DataFusionError::Plan("neutral plan error".to_string()),
                DataFusionError::External(Box::new(DataFusionError::Internal(
                    "inner error".to_string(),
                ))),
            ]
        };

        for error in errors().into_iter().chain(errors().map(wrap)) {
            let error = Error::PollStream {
                error,
                location: Location::default(),
            };
            assert_eq!(error.status_code(), StatusCode::EngineExecuteQuery);
        }
    }
}