risingwave_frontend/
error.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use risingwave_batch::error::BatchError;
16use risingwave_common::array::ArrayError;
17use risingwave_common::error::{BoxedError, NoFunction, NotImplemented};
18use risingwave_common::secret::SecretError;
19use risingwave_common::session_config::SessionConfigError;
20use risingwave_common::util::value_encoding::error::ValueEncodingError;
21use risingwave_connector::error::ConnectorError;
22use risingwave_connector::sink::SinkError;
23use risingwave_expr::ExprError;
24use risingwave_pb::PbFieldNotFound;
25use risingwave_rpc_client::error::{RpcError, TonicStatusWrapper};
26use thiserror::Error;
27use tokio::task::JoinError;
28
29use crate::expr::CastError;
30
31/// The error type for the frontend crate, acting as the top-level error type for the
32/// entire RisingWave project.
33// TODO(error-handling): this is migrated from the `common` crate, and there could
34// be some further refactoring to do:
35// - Some variants are never constructed.
36// - Some variants store a type-erased `BoxedError` to resolve the reverse dependency.
37//   It's not necessary anymore as the error type is now defined at the top-level.
38#[derive(Error, thiserror_ext::ReportDebug, thiserror_ext::Box, thiserror_ext::Macro)]
39#[thiserror_ext(newtype(name = RwError, backtrace), macro(path = "crate::error"))]
40pub enum ErrorCode {
41    #[error("internal error: {0}")]
42    InternalError(String),
43    // TODO: unify with the above
44    #[error(transparent)]
45    Uncategorized(
46        #[from]
47        #[backtrace]
48        anyhow::Error,
49    ),
50    #[error("connector error: {0}")]
51    ConnectorError(
52        #[source]
53        #[backtrace]
54        BoxedError,
55    ),
56    #[error(transparent)]
57    NotImplemented(#[from] NotImplemented),
58    // Tips: Use this only if it's intended to reject the query
59    #[error("Not supported: {0}\nHINT: {1}")]
60    NotSupported(String, String),
61    #[error(transparent)]
62    NoFunction(#[from] NoFunction),
63    #[error(transparent)]
64    IoError(#[from] std::io::Error),
65    #[error("Storage error: {0}")]
66    StorageError(
67        #[backtrace]
68        #[source]
69        BoxedError,
70    ),
71    #[error("Expr error: {0}")]
72    ExprError(
73        #[source]
74        #[backtrace]
75        BoxedError,
76    ),
77    // TODO(error-handling): there's a limitation that `#[transparent]` can't be used with `#[backtrace]` if no `#[from]`
78    // So we emulate a transparent error with "{0}" display here.
79    #[error("{0}")]
80    BatchError(
81        #[source]
82        #[backtrace]
83        // `BatchError`
84        BoxedError,
85    ),
86    #[error("Array error: {0}")]
87    ArrayError(
88        #[from]
89        #[backtrace]
90        ArrayError,
91    ),
92    #[error("Stream error: {0}")]
93    StreamError(
94        #[backtrace]
95        #[source]
96        BoxedError,
97    ),
98    // TODO(error-handling): there's a limitation that `#[transparent]` can't be used with `#[backtrace]` if no `#[from]`
99    // So we emulate a transparent error with "{0}" display here.
100    #[error("{0}")]
101    RpcError(
102        #[source]
103        #[backtrace]
104        // `tonic::transport::Error`, `TonicStatusWrapper`, or `RpcError`
105        BoxedError,
106    ),
107    // TODO: use a new type for bind error
108    // TODO(error-handling): should prefer use error types than strings.
109    #[error("Bind error: {0}")]
110    BindError(#[message] String),
111    // TODO: only keep this one
112    #[error("Failed to bind expression: {expr}: {error}")]
113    BindErrorRoot {
114        expr: String,
115        #[source]
116        #[backtrace]
117        error: BoxedError,
118    },
119    #[error(transparent)]
120    CastError(
121        #[from]
122        #[backtrace]
123        CastError,
124    ),
125    #[error("Catalog error: {0}")]
126    CatalogError(
127        #[source]
128        #[backtrace]
129        BoxedError,
130    ),
131    #[error("Protocol error: {0}")]
132    ProtocolError(String),
133    #[error("Scheduler error: {0}")]
134    SchedulerError(
135        #[source]
136        #[backtrace]
137        BoxedError,
138    ),
139    #[error("Task not found")]
140    TaskNotFound,
141    #[error("Session not found")]
142    SessionNotFound,
143    #[error("Item not found: {0}")]
144    ItemNotFound(String),
145    #[error("Invalid input syntax: {0}")]
146    InvalidInputSyntax(String),
147    #[error("Can not compare in memory: {0}")]
148    MemComparableError(#[from] memcomparable::Error),
149    #[error("Error while de/se values: {0}")]
150    ValueEncodingError(
151        #[from]
152        #[backtrace]
153        ValueEncodingError,
154    ),
155    #[error("Invalid value `{config_value}` for `{config_entry}`")]
156    InvalidConfigValue {
157        config_entry: String,
158        config_value: String,
159    },
160    #[error("Invalid Parameter Value: {0}")]
161    InvalidParameterValue(String),
162    #[error("Sink error: {0}")]
163    SinkError(
164        #[source]
165        #[backtrace]
166        BoxedError,
167    ),
168    #[error("Permission denied: {0}")]
169    PermissionDenied(String),
170    #[error("Failed to get/set session config: {0}")]
171    SessionConfig(
172        #[from]
173        #[backtrace]
174        SessionConfigError,
175    ),
176    #[error("Secret error: {0}")]
177    SecretError(
178        #[from]
179        #[backtrace]
180        SecretError,
181    ),
182    #[error("{0} has been deprecated, please use {1} instead.")]
183    Deprecated(String, String),
184}
185
186/// The result type for the frontend crate.
187pub type Result<T> = std::result::Result<T, RwError>;
188
189impl From<TonicStatusWrapper> for RwError {
190    fn from(status: TonicStatusWrapper) -> Self {
191        use tonic::Code;
192
193        let message = status.inner().message();
194
195        // TODO(error-handling): `message` loses the source chain.
196        match status.inner().code() {
197            Code::InvalidArgument => ErrorCode::InvalidParameterValue(message.to_owned()),
198            Code::NotFound | Code::AlreadyExists => ErrorCode::CatalogError(status.into()),
199            Code::PermissionDenied => ErrorCode::PermissionDenied(message.to_owned()),
200            Code::Cancelled => ErrorCode::SchedulerError(status.into()),
201            _ => ErrorCode::RpcError(status.into()),
202        }
203        .into()
204    }
205}
206
207impl From<RpcError> for RwError {
208    fn from(r: RpcError) -> Self {
209        match r {
210            RpcError::GrpcStatus(status) => TonicStatusWrapper::into(*status),
211            _ => ErrorCode::RpcError(r.into()).into(),
212        }
213    }
214}
215
216impl From<ExprError> for RwError {
217    fn from(s: ExprError) -> Self {
218        ErrorCode::ExprError(Box::new(s)).into()
219    }
220}
221
222impl From<SinkError> for RwError {
223    fn from(e: SinkError) -> Self {
224        ErrorCode::SinkError(Box::new(e)).into()
225    }
226}
227
228impl From<ConnectorError> for RwError {
229    fn from(e: ConnectorError) -> Self {
230        ErrorCode::ConnectorError(e.into()).into()
231    }
232}
233
234impl From<PbFieldNotFound> for RwError {
235    fn from(err: PbFieldNotFound) -> Self {
236        ErrorCode::InternalError(format!(
237            "Failed to decode prost: field not found `{}`",
238            err.0
239        ))
240        .into()
241    }
242}
243
244impl From<BatchError> for RwError {
245    fn from(s: BatchError) -> Self {
246        ErrorCode::BatchError(Box::new(s)).into()
247    }
248}
249
250impl From<JoinError> for RwError {
251    fn from(join_error: JoinError) -> Self {
252        ErrorCode::Uncategorized(join_error.into()).into()
253    }
254}
255
256// For errors without a concrete type, put them into `Uncategorized`.
257impl From<BoxedError> for RwError {
258    fn from(e: BoxedError) -> Self {
259        // Show that the error is of `BoxedKind`, instead of `AdhocKind` which loses the sources.
260        // This is essentially expanded from `anyhow::anyhow!(e)`.
261        let e = anyhow::__private::kind::BoxedKind::anyhow_kind(&e).new(e);
262        ErrorCode::Uncategorized(e).into()
263    }
264}
risingwave_frontend/error.rs

risingwave_frontend/
error.rs
