typedb_driver/common/
error.rs

1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements.  See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership.  The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License.  You may obtain a copy of the License at
9 *
10 *   http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied.  See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20use std::{collections::HashSet, error::Error as StdError, fmt};
21
22use itertools::Itertools;
23use tonic::{Code, Status};
24use tonic_types::{ErrorDetails, ErrorInfo, StatusExt};
25
26use super::{address::Address, RequestID};
27
28macro_rules! error_messages {
29    {
30        $name:ident code: $code_pfx:literal, type: $message_pfx:literal,
31        $($error_name:ident $({ $($field:ident : $inner:ty),+ $(,)? })? = $code:literal: $body:literal),+ $(,)?
32    } => {
33        #[derive(Clone, Eq, PartialEq)]
34        pub enum $name {$(
35            $error_name$( { $($field: $inner),+ })?,
36        )*}
37
38        impl $name {
39            pub const PREFIX: &'static str = $code_pfx;
40
41            pub const fn code(&self) -> usize {
42                match self {$(
43                    Self::$error_name $({ $($field: _),+ })? => $code,
44                )*}
45            }
46
47            pub fn format_code(&self) -> String {
48                format!(concat!("[", $code_pfx, "{}{}]"), self.padding(), self.code())
49            }
50
51            pub fn message(&self) -> String {
52                match self {$(
53                    Self::$error_name $({$($field),+})? => format!($body $($(, $field = $field)+)?),
54                )*}
55            }
56
57            const fn max_code() -> usize {
58                let mut max = usize::MIN;
59                $(max = if $code > max { $code } else { max };)*
60                max
61            }
62
63            const fn num_digits(x: usize) -> usize {
64                if (x < 10) { 1 } else { 1 + Self::num_digits(x/10) }
65            }
66
67            const fn padding(&self) -> &'static str {
68                match Self::num_digits(Self::max_code()) - Self::num_digits(self.code()) {
69                    0 => "",
70                    1 => "0",
71                    2 => "00",
72                    3 => "000",
73                    _ => unreachable!(),
74                }
75            }
76
77            const fn name(&self) -> &'static str {
78                match self {$(
79                    Self::$error_name $({ $($field: _),+ })? => concat!(stringify!($name), "::", stringify!($error_name)),
80                )*}
81            }
82        }
83
84        impl std::fmt::Display for $name {
85            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
86                write!(
87                    f,
88                    concat!("[", $code_pfx, "{}{}] ", $message_pfx, ": {}"),
89                    self.padding(),
90                    self.code(),
91                    self.message()
92                )
93            }
94        }
95
96        impl std::fmt::Debug for $name {
97            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
98                let mut debug_struct = f.debug_struct(self.name());
99                debug_struct.field("message", &format!("{}", self));
100                $(
101                    $(
102                        if let Self::$error_name { $($field),+ } = &self {
103                            $(debug_struct.field(stringify!($field), &$field);)+
104                        }
105                    )?
106                )*
107                debug_struct.finish()
108            }
109        }
110
111        impl std::error::Error for $name {
112            fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
113                None
114            }
115        }
116    };
117}
118
119error_messages! { ConnectionError
120    code: "CXN", type: "Connection Error",
121    RPCMethodUnavailable { message: String } =
122        1: "The server does not support this method, please check the driver-server compatibility:\n'{message}'.",
123    ServerConnectionFailed { addresses: Vec<Address> } =
124        2: "Unable to connect to TypeDB server(s) at: \n{addresses:?}",
125    ServerConnectionFailedWithError { error: String } =
126        3: "Unable to connect to TypeDB server(s), received errors: \n{error}",
127    ServerConnectionFailedStatusError { error: String } =
128        4: "Unable to connect to TypeDB server(s), received network or protocol error: \n{error}",
129    ServerConnectionIsClosed =
130        5: "The connection has been closed and no further operation is allowed.",
131    TransactionIsClosed =
132        6: "The transaction is closed and no further operation is allowed.",
133    TransactionIsClosedWithErrors { errors: String } =
134        7: "The transaction is closed because of the error(s):\n{errors}",
135    DatabaseNotFound { name: String } =
136        8: "Database '{name}' not found.",
137    MissingResponseField { field: &'static str } =
138        9: "Missing field in message received from server: '{field}'. This is either a version compatibility issue or a bug.",
139    UnknownRequestId { request_id: RequestID } =
140        10: "Received a response with unknown request id '{request_id}'",
141    UnexpectedResponse { response: String } =
142        11: "Received unexpected response from server: '{response}'. This is either a version compatibility issue or a bug.",
143    InvalidResponseField { name: &'static str } =
144        12: "Invalid field in message received from server: '{name}'. This is either a version compatibility issue or a bug.",
145    QueryStreamNoResponse =
146        13: "Didn't receive any server responses for the query.",
147    UnexpectedQueryType { query_type: i32 } =
148        14: "Unexpected query type in message received from server: {query_type}. This is either a version compatibility issue or a bug.",
149    ClusterReplicaNotPrimary =
150        15: "The replica is not the primary replica.",
151    ClusterAllNodesFailed { errors: String } =
152        16: "Attempted connecting to all TypeDB Cluster servers, but the following errors occurred: \n{errors}.",
153    TokenCredentialInvalid =
154        17: "Invalid token credentials.",
155    EncryptionSettingsMismatch =
156        18: "Unable to connect to TypeDB: possible encryption settings mismatch.",
157    SSLCertificateNotValidated =
158        19: "SSL handshake with TypeDB failed: the server's identity could not be verified. Possible CA mismatch.",
159    BrokenPipe =
160        20: "Stream closed because of a broken pipe. This could happen if you are attempting to connect to an unencrypted TypeDB server using a TLS-enabled credentials.",
161    ConnectionFailed =
162        21: "Connection failed. Please check the server is running and the address is accessible. Encrypted TypeDB endpoints may also have misconfigured SSL certificates.",
163    MissingPort { address: String } =
164        22: "Invalid URL '{address}': missing port.",
165    AddressTranslationMismatch { unknown: HashSet<Address>, unmapped: HashSet<Address> } =
166        23: "Address translation map does not match the server's advertised address list. User-provided servers not in the advertised list: {unknown:?}. Advertised servers not mapped by user: {unmapped:?}.",
167    ValueTimeZoneNameNotRecognised { time_zone: String } =
168        24: "Time zone provided by the server has name '{time_zone}', which is not an officially recognized timezone.",
169    ValueTimeZoneOffsetNotRecognised { offset: i32 } =
170        25: "Time zone provided by the server has numerical offset '{offset}', which is not recognised as a valid value for offset in seconds.",
171    ValueStructNotImplemented =
172        26: "Struct valued responses are not yet supported by the driver.",
173    ListsNotImplemented =
174        27: "Lists are not yet supported by the driver.",
175    UnexpectedKind { kind: i32 } =
176        28: "Unexpected kind in message received from server: {kind}. This is either a version compatibility issue or a bug.",
177    UnexpectedConnectionClose =
178        29: "Connection closed unexpectedly.",
179    DatabaseImportChannelIsClosed =
180        30: "The database import channel is closed and no further operation is allowed.",
181    DatabaseImportStreamUnexpectedResponse =
182        31: "The database import stream received an unexpected response in the process. It is either a version compatibility issue or a bug.",
183    DatabaseExportChannelIsClosed =
184        32: "The database export channel is closed and no further operation is allowed.",
185    DatabaseExportStreamNoResponse =
186        33: "Didn't receive any server responses for the database export command.",
187}
188
189error_messages! { ConceptError
190    code: "CPT", type: "Concept Error",
191    UnavailableRowVariable { variable: String } =
192        1: "Cannot get concept from a concept row by variable '{variable}'.",
193    UnavailableRowIndex { index: usize } =
194        2: "Cannot get concept from a concept row by index '{index}'.",
195}
196
197error_messages! { MigrationError
198    code: "MGT", type: "Migration Error",
199    CannotOpenImportFile { path: String, reason: String } =
200        1: "Cannot open import file '{path}': {reason}",
201    CannotCreateExportFile { path: String, reason: String } =
202        2: "Cannot create export file '{path}': {reason}",
203    CannotExportToTheSameFile =
204        3: "Cannot export both schema and data to the same file.",
205    CannotDecodeImportedConcept =
206        4: "Cannot decode a concept from the provided import file. Make sure to pass a correct database file produced by a TypeDB export operation.",
207    CannotDecodeImportedConceptLength =
208        5: "Cannot decode a concept length from the provided import file. Make sure to pass a correct database file produced by a TypeDB export operation.",
209    CannotEncodeExportedConcept =
210        6: "Cannot encode a concept for export. It's either a version compatibility error or a bug."
211}
212
213error_messages! { InternalError
214    code: "INT", type: "Internal Error",
215    RecvError =
216        1: "Channel is closed.",
217    SendError =
218        2: "Unable to send response over callback channel (receiver dropped).",
219    UnexpectedRequestType { request_type: String } =
220        3: "Unexpected request type for remote procedure call: {request_type}. This is either a version compatibility issue or a bug.",
221    UnexpectedResponseType { response_type: String } =
222        4: "Unexpected response type for remote procedure call: {response_type}. This is either a version compatibility issue or a bug.",
223    UnknownServer { server: Address } =
224        5: "Received replica at unrecognized server: {server}.",
225    EnumOutOfBounds { value: i32, enum_name: &'static str } =
226        6: "Value '{value}' is out of bounds for enum '{enum_name}'.",
227}
228
229#[derive(Clone, PartialEq, Eq)]
230pub struct ServerError {
231    error_code: String,
232    error_domain: String,
233    message: String,
234    stack_trace: Vec<String>,
235}
236
237impl ServerError {
238    pub(crate) fn new(error_code: String, error_domain: String, message: String, stack_trace: Vec<String>) -> Self {
239        Self { error_code, error_domain, message, stack_trace }
240    }
241
242    pub(crate) fn format_code(&self) -> &str {
243        &self.error_code
244    }
245
246    pub(crate) fn message(&self) -> String {
247        self.to_string()
248    }
249
250    fn to_string(&self) -> String {
251        if self.stack_trace.is_empty() {
252            format!("[{}] {}. {}", self.error_code, self.error_domain, self.message)
253        } else {
254            format!("\n{}", self.stack_trace.join("\nCaused: "))
255        }
256    }
257}
258
259impl fmt::Display for ServerError {
260    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
261        write!(f, "{}", self.to_string())
262    }
263}
264
265impl fmt::Debug for ServerError {
266    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
267        fmt::Display::fmt(self, f)
268    }
269}
270
271/// Represents errors encountered during operation.
272#[derive(Clone, Debug, PartialEq, Eq)]
273pub enum Error {
274    Connection(ConnectionError),
275    Concept(ConceptError),
276    Migration(MigrationError),
277    Internal(InternalError),
278    Server(ServerError),
279    Other(String),
280}
281
282impl Error {
283    pub fn code(&self) -> String {
284        match self {
285            Self::Connection(error) => error.format_code(),
286            Self::Concept(error) => error.format_code(),
287            Self::Migration(error) => error.format_code(),
288            Self::Internal(error) => error.format_code(),
289            Self::Server(error) => error.format_code().to_owned(),
290            Self::Other(_error) => String::new(),
291        }
292    }
293
294    pub fn message(&self) -> String {
295        match self {
296            Self::Connection(error) => error.message(),
297            Self::Concept(error) => error.message(),
298            Self::Migration(error) => error.message(),
299            Self::Internal(error) => error.message(),
300            Self::Server(error) => error.message(),
301            Self::Other(error) => error.clone(),
302        }
303    }
304
305    fn try_extracting_connection_error(status: &Status, code: &str) -> Option<ConnectionError> {
306        // TODO: We should probably catch more connection errors instead of wrapping them into
307        // ServerErrors. However, the most valuable information even for connection is inside
308        // stacktraces now.
309        match code {
310            "AUT2" | "AUT3" => Some(ConnectionError::TokenCredentialInvalid {}),
311            _ => None,
312        }
313    }
314
315    fn from_message(message: &str) -> Self {
316        // TODO: Consider converting some of the messages to connection errors
317        Self::Other(message.to_owned())
318    }
319
320    fn parse_unavailable(status_message: &str) -> Error {
321        if status_message == "broken pipe" {
322            Error::Connection(ConnectionError::BrokenPipe)
323        } else if status_message.contains("received corrupt message") {
324            Error::Connection(ConnectionError::EncryptionSettingsMismatch)
325        } else if status_message.contains("UnknownIssuer") {
326            Error::Connection(ConnectionError::SSLCertificateNotValidated)
327        } else if status_message.contains("Connection refused") {
328            Error::Connection(ConnectionError::ConnectionFailed)
329        } else {
330            Error::Connection(ConnectionError::ServerConnectionFailedStatusError { error: status_message.to_owned() })
331        }
332    }
333}
334
335impl fmt::Display for Error {
336    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
337        match self {
338            Self::Connection(error) => write!(f, "{error}"),
339            Self::Concept(error) => write!(f, "{error}"),
340            Self::Migration(error) => write!(f, "{error}"),
341            Self::Internal(error) => write!(f, "{error}"),
342            Self::Server(error) => write!(f, "{error}"),
343            Self::Other(message) => write!(f, "{message}"),
344        }
345    }
346}
347
348impl StdError for Error {
349    fn source(&self) -> Option<&(dyn StdError + 'static)> {
350        match self {
351            Self::Connection(error) => Some(error),
352            Self::Concept(error) => Some(error),
353            Self::Migration(error) => Some(error),
354            Self::Internal(error) => Some(error),
355            Self::Server(_) => None,
356            Self::Other(_) => None,
357        }
358    }
359}
360
361impl From<ConnectionError> for Error {
362    fn from(error: ConnectionError) -> Self {
363        Self::Connection(error)
364    }
365}
366
367impl From<ConceptError> for Error {
368    fn from(error: ConceptError) -> Self {
369        Self::Concept(error)
370    }
371}
372
373impl From<InternalError> for Error {
374    fn from(error: InternalError) -> Self {
375        Self::Internal(error)
376    }
377}
378
379impl From<ServerError> for Error {
380    fn from(error: ServerError) -> Self {
381        Self::Server(error)
382    }
383}
384
385impl From<Status> for Error {
386    fn from(status: Status) -> Self {
387        if let Ok(details) = status.check_error_details() {
388            if let Some(bad_request) = details.bad_request() {
389                Self::Connection(ConnectionError::ServerConnectionFailedWithError {
390                    error: format!("{:?}", bad_request),
391                })
392            } else if let Some(error_info) = details.error_info() {
393                let code = error_info.reason.clone();
394                if let Some(connection_error) = Self::try_extracting_connection_error(&status, &code) {
395                    return Self::Connection(connection_error);
396                }
397                let domain = error_info.domain.clone();
398                let stack_trace =
399                    if let Some(debug_info) = details.debug_info() { debug_info.stack_entries.clone() } else { vec![] };
400
401                Self::Server(ServerError::new(code, domain, status.message().to_owned(), stack_trace))
402            } else {
403                Self::from_message(status.message())
404            }
405        } else {
406            if status.code() == Code::Unavailable {
407                Self::parse_unavailable(status.message())
408            } else if status.code() == Code::Unknown
409                || is_rst_stream(&status)
410                || status.code() == Code::FailedPrecondition
411                || status.code() == Code::AlreadyExists
412            {
413                Self::Connection(ConnectionError::ServerConnectionFailedStatusError {
414                    error: status.message().to_owned(),
415                })
416            } else if status.code() == Code::Unimplemented {
417                Self::Connection(ConnectionError::RPCMethodUnavailable { message: status.message().to_owned() })
418            } else {
419                Self::from_message(status.message())
420            }
421        }
422    }
423}
424
425fn is_rst_stream(status: &Status) -> bool {
426    // "Received Rst Stream" occurs if the server is in the process of shutting down.
427    status.message().contains("Received Rst Stream")
428}
429
430impl From<http::uri::InvalidUri> for Error {
431    fn from(err: http::uri::InvalidUri) -> Self {
432        Self::Other(err.to_string())
433    }
434}
435
436impl From<tonic::transport::Error> for Error {
437    fn from(err: tonic::transport::Error) -> Self {
438        Self::Other(err.to_string())
439    }
440}
441
442impl<T> From<tokio::sync::mpsc::error::SendError<T>> for Error {
443    fn from(_err: tokio::sync::mpsc::error::SendError<T>) -> Self {
444        Self::Internal(InternalError::SendError)
445    }
446}
447
448impl From<tokio::sync::oneshot::error::RecvError> for Error {
449    fn from(_err: tokio::sync::oneshot::error::RecvError) -> Self {
450        Self::Internal(InternalError::RecvError)
451    }
452}
453
454impl From<crossbeam::channel::RecvError> for Error {
455    fn from(_err: crossbeam::channel::RecvError) -> Self {
456        Self::Internal(InternalError::RecvError)
457    }
458}
459
460impl<T> From<crossbeam::channel::SendError<T>> for Error {
461    fn from(_err: crossbeam::channel::SendError<T>) -> Self {
462        Self::Internal(InternalError::SendError)
463    }
464}
465
466impl From<String> for Error {
467    fn from(err: String) -> Self {
468        Self::Other(err)
469    }
470}
471
472impl From<std::io::Error> for Error {
473    fn from(err: std::io::Error) -> Self {
474        Self::Other(err.to_string())
475    }
476}
typedb_driver/common/error.rs

typedb_driver/common/
error.rs
