metric_engine/

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.

use std::any::Any;
use std::sync::Arc;

use common_error::ext::{BoxedError, ErrorExt, RetryHint};
use common_error::status_code::StatusCode;
use common_macro::stack_trace_debug;
use datatypes::prelude::ConcreteDataType;
use snafu::{Location, Snafu};
use store_api::region_request::RegionRequest;
use store_api::storage::{FileId, RegionId};

#[derive(Snafu)]
#[snafu(visibility(pub))]
#[stack_trace_debug]
pub enum Error {
    #[snafu(display("Failed to create mito region, region type: {}", region_type))]
    CreateMitoRegion {
        region_type: String,
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to open mito region, region type: {}", region_type))]
    OpenMitoRegion {
        region_type: String,
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to clean up mito region, region type: {}", region_type))]
    CleanUpMitoRegion {
        region_type: String,
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to batch open mito region"))]
    BatchOpenMitoRegion {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to batch catchup mito region"))]
    BatchCatchupMitoRegion {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("No open region result for region {}", region_id))]
    NoOpenRegionResult {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to close mito region, region id: {}", region_id))]
    CloseMitoRegion {
        region_id: RegionId,
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to deserialize column metadata from {}", raw))]
    DeserializeColumnMetadata {
        raw: String,
        #[snafu(source)]
        error: serde_json::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to serialize column metadata"))]
    SerializeColumnMetadata {
        #[snafu(source)]
        error: serde_json::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to serialize region manifest info"))]
    SerializeRegionManifestInfo {
        #[snafu(source)]
        error: serde_json::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to decode base64 column value"))]
    DecodeColumnValue {
        #[snafu(source)]
        error: base64::DecodeError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to parse region id from {}", raw))]
    ParseRegionId {
        raw: String,
        #[snafu(source)]
        error: <u64 as std::str::FromStr>::Err,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to parse region options: {}", reason))]
    ParseRegionOptions {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Mito read operation fails"))]
    MitoReadOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Mito copy region from operation fails, source region id: {}, target region id: {}",
        source_region_id,
        target_region_id
    ))]
    MitoCopyRegionFromOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
        source_region_id: RegionId,
        target_region_id: RegionId,
    },

    #[snafu(display("Mito edit region operation fails, region id: {}", region_id))]
    MitoEditRegion {
        region_id: RegionId,
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to encode primary key"))]
    EncodePrimaryKey {
        source: mito_codec::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Mito write operation fails"))]
    MitoWriteOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Mito flush operation fails"))]
    MitoFlushOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Mito truncate operation fails"))]
    MitoTruncateOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Mito sync operation fails"))]
    MitoSyncOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Mito enter staging operation fails"))]
    MitoEnterStagingOperation {
        source: BoxedError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to collect record batch stream"))]
    CollectRecordBatchStream {
        source: common_recordbatch::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Internal column {} is reserved", column))]
    InternalColumnOccupied {
        column: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Required table option is missing"))]
    MissingRegionOption {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Region options are conflicted"))]
    ConflictRegionOption {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Physical region {} not found", region_id))]
    PhysicalRegionNotFound {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Logical region {} not found", region_id))]
    LogicalRegionNotFound {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Column type mismatch. Expect {:?}, got {:?}", expect, actual))]
    ColumnTypeMismatch {
        expect: ConcreteDataType,
        actual: ConcreteDataType,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Column {} not found in logical region {}", name, region_id))]
    ColumnNotFound {
        name: String,
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Table id count mismatch. Expect {}, got {}", expected, actual))]
    TableIdCountMismatch {
        expected: usize,
        actual: usize,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Alter request to physical region is forbidden"))]
    ForbiddenPhysicalAlter {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Write request to physical region is forbidden"))]
    ForbiddenPhysicalWrite {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Invalid region metadata"))]
    InvalidMetadata {
        source: store_api::metadata::MetadataError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Invalid request for region {}, reason: {}", region_id, reason))]
    InvalidRequest {
        reason: String,
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Physical region {} is busy, there are still some logical regions using it",
        region_id
    ))]
    PhysicalRegionBusy {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Unsupported region request: {}", request))]
    UnsupportedRegionRequest {
        request: Box<RegionRequest>,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Unsupported remap manifests request for region {}", region_id))]
    UnsupportedRemapManifestsRequest {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Unsupported sync region from request for region {}", region_id))]
    UnsupportedSyncRegionFromRequest {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Missing file metas in region {}, file ids: {:?}", region_id, file_ids))]
    MissingFiles {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
        file_ids: Vec<FileId>,
    },

    #[snafu(display("Unsupported alter kind: {}", kind))]
    UnsupportedAlterKind {
        kind: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Multiple field column found: {} and {}", previous, current))]
    MultipleFieldColumn {
        previous: String,
        current: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Adding field column {} to physical table", name))]
    AddingFieldColumn {
        name: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("No field column found"))]
    NoFieldColumn {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to set SKIPPING index option"))]
    SetSkippingIndexOption {
        source: datatypes::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Failed to create default value for column {} of region {}",
        column,
        region_id
    ))]
    CreateDefault {
        region_id: RegionId,
        column: String,
        source: datatypes::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Unexpected request: {}", reason))]
    UnexpectedRequest {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Expected metric manifest info, region: {}", region_id))]
    MetricManifestInfo {
        region_id: RegionId,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to start repeated task: {}", name))]
    StartRepeatedTask {
        name: String,
        source: common_runtime::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Get value from cache"))]
    CacheGet {
        source: Arc<Error>,
        #[snafu(implicit)]
        location: Location,
    },
}

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

impl ErrorExt for Error {
    fn status_code(&self) -> StatusCode {
        use Error::*;

        match self {
            InternalColumnOccupied { .. }
            | MissingRegionOption { .. }
            | ConflictRegionOption { .. }
            | ColumnTypeMismatch { .. }
            | TableIdCountMismatch { .. }
            | PhysicalRegionBusy { .. }
            | MultipleFieldColumn { .. }
            | NoFieldColumn { .. }
            | AddingFieldColumn { .. }
            | ParseRegionOptions { .. }
            | UnexpectedRequest { .. }
            | UnsupportedAlterKind { .. }
            | UnsupportedRemapManifestsRequest { .. }
            | UnsupportedSyncRegionFromRequest { .. }
            | InvalidRequest { .. }
            | CreateDefault { .. } => StatusCode::InvalidArguments,

            ForbiddenPhysicalAlter { .. }
            | ForbiddenPhysicalWrite { .. }
            | UnsupportedRegionRequest { .. }
            | MissingFiles { .. } => StatusCode::Unsupported,

            DeserializeColumnMetadata { .. }
            | SerializeColumnMetadata { .. }
            | DecodeColumnValue { .. }
            | ParseRegionId { .. }
            | InvalidMetadata { .. }
            | SetSkippingIndexOption { .. }
            | SerializeRegionManifestInfo { .. }
            | NoOpenRegionResult { .. } => StatusCode::Unexpected,

            PhysicalRegionNotFound { .. } | LogicalRegionNotFound { .. } => {
                StatusCode::RegionNotFound
            }

            ColumnNotFound { .. } => StatusCode::TableColumnNotFound,

            CreateMitoRegion { source, .. }
            | OpenMitoRegion { source, .. }
            | CleanUpMitoRegion { source, .. }
            | CloseMitoRegion { source, .. }
            | MitoReadOperation { source, .. }
            | MitoWriteOperation { source, .. }
            | MitoFlushOperation { source, .. }
            | MitoTruncateOperation { source, .. }
            | MitoSyncOperation { source, .. }
            | MitoEnterStagingOperation { source, .. }
            | BatchOpenMitoRegion { source, .. }
            | BatchCatchupMitoRegion { source, .. }
            | MitoCopyRegionFromOperation { source, .. }
            | MitoEditRegion { source, .. } => source.status_code(),

            EncodePrimaryKey { source, .. } => source.status_code(),

            CollectRecordBatchStream { source, .. } => source.status_code(),

            StartRepeatedTask { source, .. } => source.status_code(),

            MetricManifestInfo { .. } => StatusCode::Internal,

            CacheGet { source, .. } => source.status_code(),
        }
    }

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

    fn retry_hint(&self) -> RetryHint {
        use Error::*;

        match self {
            CreateMitoRegion { source, .. }
            | OpenMitoRegion { source, .. }
            | CleanUpMitoRegion { source, .. }
            | BatchOpenMitoRegion { source, .. }
            | BatchCatchupMitoRegion { source, .. }
            | CloseMitoRegion { source, .. }
            | MitoReadOperation { source, .. }
            | MitoWriteOperation { source, .. }
            | MitoFlushOperation { source, .. }
            | MitoTruncateOperation { source, .. }
            | MitoSyncOperation { source, .. }
            | MitoEnterStagingOperation { source, .. }
            | MitoCopyRegionFromOperation { source, .. }
            | MitoEditRegion { source, .. } => source.retry_hint(),

            EncodePrimaryKey { source, .. } => source.retry_hint(),
            CollectRecordBatchStream { source, .. } => source.retry_hint(),
            StartRepeatedTask { source, .. } => source.retry_hint(),
            CacheGet { source, .. } => source.retry_hint(),

            _ => RetryHint::NonRetryable,
        }
    }
}