velesdb-core 1.15.0

//! Error types for `VelesQL` parsing.

use std::fmt;

/// Error that occurred during parsing.
#[derive(Debug, Clone, PartialEq)]
pub struct ParseError {
    /// Kind of error.
    pub kind: ParseErrorKind,
    /// Position in the input where the error occurred.
    pub position: usize,
    /// The problematic input fragment.
    pub fragment: String,
    /// Human-readable message.
    pub message: String,
}

impl ParseError {
    /// Creates a new parse error.
    #[must_use]
    pub fn new(
        kind: ParseErrorKind,
        position: usize,
        fragment: impl Into<String>,
        message: impl Into<String>,
    ) -> Self {
        Self {
            kind,
            position,
            fragment: fragment.into(),
            message: message.into(),
        }
    }

    /// Creates a syntax error.
    #[must_use]
    pub fn syntax(
        position: usize,
        fragment: impl Into<String>,
        message: impl Into<String>,
    ) -> Self {
        Self::new(ParseErrorKind::SyntaxError, position, fragment, message)
    }

    /// Creates an unexpected token error.
    #[must_use]
    pub fn unexpected_token(position: usize, fragment: impl Into<String>, expected: &str) -> Self {
        Self::new(
            ParseErrorKind::UnexpectedToken,
            position,
            fragment,
            format!("Expected {expected}"),
        )
    }

    /// Creates an unknown column error.
    #[must_use]
    pub fn unknown_column(column: impl Into<String>) -> Self {
        let col = column.into();
        Self::new(
            ParseErrorKind::UnknownColumn,
            0,
            col.clone(),
            format!("Unknown column '{col}'"),
        )
    }

    /// Creates a missing parameter error.
    #[must_use]
    pub fn missing_parameter(param: impl Into<String>) -> Self {
        let p = param.into();
        Self::new(
            ParseErrorKind::MissingParameter,
            0,
            p.clone(),
            format!("Missing parameter '${p}'"),
        )
    }
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "[{}] {} at position {}",
            self.kind.code(),
            self.message,
            self.position
        )
    }
}

impl std::error::Error for ParseError {}

/// Kind of parse error.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ParseErrorKind {
    /// Syntax error (E001).
    SyntaxError,
    /// Unexpected token (E001).
    UnexpectedToken,
    /// Unknown column (E002).
    UnknownColumn,
    /// Collection not found (E003).
    CollectionNotFound,
    /// Vector dimension mismatch (E004).
    DimensionMismatch,
    /// Missing parameter (E005).
    MissingParameter,
    /// Type mismatch (E006).
    TypeMismatch,
    /// Query complexity guardrail exceeded (E007).
    ComplexityLimit,
}

impl ParseErrorKind {
    /// Returns the error code.
    #[must_use]
    pub const fn code(&self) -> &'static str {
        match self {
            Self::SyntaxError | Self::UnexpectedToken => "E001",
            Self::UnknownColumn => "E002",
            Self::CollectionNotFound => "E003",
            Self::DimensionMismatch => "E004",
            Self::MissingParameter => "E005",
            Self::TypeMismatch => "E006",
            Self::ComplexityLimit => "E007",
        }
    }
}

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

    #[test]
    fn test_parse_error_new() {
        let err = ParseError::new(ParseErrorKind::SyntaxError, 10, "SELECT", "Invalid syntax");
        assert_eq!(err.kind, ParseErrorKind::SyntaxError);
        assert_eq!(err.position, 10);
        assert_eq!(err.fragment, "SELECT");
        assert_eq!(err.message, "Invalid syntax");
    }

    #[test]
    fn test_parse_error_syntax() {
        let err = ParseError::syntax(5, "FROM", "Expected table name");
        assert_eq!(err.kind, ParseErrorKind::SyntaxError);
        assert_eq!(err.position, 5);
    }

    #[test]
    fn test_parse_error_unexpected_token() {
        let err = ParseError::unexpected_token(0, "xyz", "identifier");
        assert_eq!(err.kind, ParseErrorKind::UnexpectedToken);
        assert!(err.message.contains("Expected identifier"));
    }

    #[test]
    fn test_parse_error_unknown_column() {
        let err = ParseError::unknown_column("missing_col");
        assert_eq!(err.kind, ParseErrorKind::UnknownColumn);
        assert!(err.message.contains("missing_col"));
    }

    #[test]
    fn test_parse_error_missing_parameter() {
        let err = ParseError::missing_parameter("vector");
        assert_eq!(err.kind, ParseErrorKind::MissingParameter);
        assert!(err.message.contains("$vector"));
    }

    #[test]
    fn test_parse_error_display() {
        let err = ParseError::syntax(10, "bad", "Syntax error");
        let display = format!("{err}");
        assert!(display.contains("E001"));
        assert!(display.contains("Syntax error"));
        assert!(display.contains("10"));
    }

    #[test]
    fn test_parse_error_kind_codes() {
        assert_eq!(ParseErrorKind::SyntaxError.code(), "E001");
        assert_eq!(ParseErrorKind::UnexpectedToken.code(), "E001");
        assert_eq!(ParseErrorKind::UnknownColumn.code(), "E002");
        assert_eq!(ParseErrorKind::CollectionNotFound.code(), "E003");
        assert_eq!(ParseErrorKind::DimensionMismatch.code(), "E004");
        assert_eq!(ParseErrorKind::MissingParameter.code(), "E005");
        assert_eq!(ParseErrorKind::TypeMismatch.code(), "E006");
    }

    #[test]
    fn test_parse_error_is_std_error() {
        let err = ParseError::syntax(0, "", "test");
        let _: &dyn std::error::Error = &err;
    }
}