1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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::backtrace::{Backtrace, BacktraceStatus};
use std::fmt;
use std::fmt::{Debug, Display, Formatter};
use chrono::{DateTime, TimeZone as _, Utc};
/// Result that is a wrapper of `Result<T, iceberg::Error>`
pub type Result<T> = std::result::Result<T, Error>;
/// ErrorKind is all kinds of Error of iceberg.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum ErrorKind {
/// Iceberg don't know what happened here, and no actions other than
/// just returning it back. For example, iceberg returns an internal
/// service error.
Unexpected,
/// Iceberg data is invalid.
///
/// This error is returned when we try to read a table from iceberg but
/// failed to parse it's metadata or data file correctly.
///
/// The table could be invalid or corrupted.
DataInvalid,
/// Iceberg feature is not supported.
///
/// This error is returned when given iceberg feature is not supported.
FeatureUnsupported,
}
impl ErrorKind {
/// Convert self into static str.
pub fn into_static(self) -> &'static str {
self.into()
}
}
impl From<ErrorKind> for &'static str {
fn from(v: ErrorKind) -> &'static str {
match v {
ErrorKind::Unexpected => "Unexpected",
ErrorKind::DataInvalid => "DataInvalid",
ErrorKind::FeatureUnsupported => "FeatureUnsupported",
}
}
}
impl Display for ErrorKind {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.into_static())
}
}
/// Error is the error struct returned by all iceberg functions.
///
/// ## Display
///
/// Error can be displayed in two ways:
///
/// - Via `Display`: like `err.to_string()` or `format!("{err}")`
///
/// Error will be printed in a single line:
///
/// ```shell
/// Unexpected, context: { path: /path/to/file, called: send_async } => something wrong happened, source: networking error"
/// ```
///
/// - Via `Debug`: like `format!("{err:?}")`
///
/// Error will be printed in multi lines with more details and backtraces (if captured):
///
/// ```shell
/// Unexpected => something wrong happened
///
/// Context:
/// path: /path/to/file
/// called: send_async
///
/// Source: networking error
///
/// Backtrace:
/// 0: iceberg::error::Error::new
/// at ./src/error.rs:197:24
/// 1: iceberg::error::tests::generate_error
/// at ./src/error.rs:241:9
/// 2: iceberg::error::tests::test_error_debug_with_backtrace::{{closure}}
/// at ./src/error.rs:305:41
/// ...
/// ```
pub struct Error {
kind: ErrorKind,
message: String,
context: Vec<(&'static str, String)>,
source: Option<anyhow::Error>,
backtrace: Backtrace,
}
impl Display for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.kind)?;
if !self.context.is_empty() {
write!(f, ", context: {{ ")?;
write!(
f,
"{}",
self.context
.iter()
.map(|(k, v)| format!("{k}: {v}"))
.collect::<Vec<_>>()
.join(", ")
)?;
write!(f, " }}")?;
}
if !self.message.is_empty() {
write!(f, " => {}", self.message)?;
}
if let Some(source) = &self.source {
write!(f, ", source: {source}")?;
}
Ok(())
}
}
impl Debug for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
// If alternate has been specified, we will print like Debug.
if f.alternate() {
let mut de = f.debug_struct("Error");
de.field("kind", &self.kind);
de.field("message", &self.message);
de.field("context", &self.context);
de.field("source", &self.source);
de.field("backtrace", &self.backtrace);
return de.finish();
}
write!(f, "{}", self.kind)?;
if !self.message.is_empty() {
write!(f, " => {}", self.message)?;
}
writeln!(f)?;
if !self.context.is_empty() {
writeln!(f)?;
writeln!(f, "Context:")?;
for (k, v) in self.context.iter() {
writeln!(f, " {k}: {v}")?;
}
}
if let Some(source) = &self.source {
writeln!(f)?;
writeln!(f, "Source: {source:#}")?;
}
if self.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
writeln!(f, "Backtrace:")?;
writeln!(f, "{}", self.backtrace)?;
}
Ok(())
}
}
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
self.source.as_ref().map(|v| v.as_ref())
}
}
impl Error {
/// Create a new Error with error kind and message.
pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self {
Self {
kind,
message: message.into(),
context: Vec::default(),
source: None,
// `Backtrace::capture()` will check if backtrace has been enabled
// internally. It's zero cost if backtrace is disabled.
backtrace: Backtrace::capture(),
}
}
/// Add more context in error.
pub fn with_context(mut self, key: &'static str, value: impl Into<String>) -> Self {
self.context.push((key, value.into()));
self
}
/// Set source for error.
///
/// # Notes
///
/// If the source has been set, we will raise a panic here.
pub fn with_source(mut self, src: impl Into<anyhow::Error>) -> Self {
debug_assert!(self.source.is_none(), "the source error has been set");
self.source = Some(src.into());
self
}
/// Set the backtrace for error.
///
/// This function is served as testing purpose and not intended to be called
/// by users.
#[cfg(test)]
fn with_backtrace(mut self, backtrace: Backtrace) -> Self {
self.backtrace = backtrace;
self
}
/// Return error's kind.
///
/// Users can use this method to check error's kind and take actions.
pub fn kind(&self) -> ErrorKind {
self.kind
}
/// Return error's message.
#[inline]
pub fn message(&self) -> &str {
self.message.as_str()
}
}
macro_rules! define_from_err {
($source: path, $error_kind: path, $msg: expr) => {
impl std::convert::From<$source> for crate::error::Error {
fn from(v: $source) -> Self {
Self::new($error_kind, $msg).with_source(v)
}
}
};
}
define_from_err!(
std::str::Utf8Error,
ErrorKind::Unexpected,
"handling invalid utf-8 characters"
);
define_from_err!(
std::array::TryFromSliceError,
ErrorKind::DataInvalid,
"failed to convert byte slive to array"
);
define_from_err!(
std::num::TryFromIntError,
ErrorKind::DataInvalid,
"failed to convert integer"
);
define_from_err!(
chrono::ParseError,
ErrorKind::DataInvalid,
"Failed to parse string to date or time"
);
define_from_err!(
uuid::Error,
ErrorKind::DataInvalid,
"Failed to convert between uuid und iceberg value"
);
define_from_err!(
apache_avro::Error,
ErrorKind::DataInvalid,
"Failure in conversion with avro"
);
define_from_err!(
opendal::Error,
ErrorKind::Unexpected,
"Failure in doing io operation"
);
define_from_err!(
url::ParseError,
ErrorKind::DataInvalid,
"Failed to parse url"
);
define_from_err!(
reqwest::Error,
ErrorKind::Unexpected,
"Failed to execute http request"
);
define_from_err!(
serde_json::Error,
ErrorKind::DataInvalid,
"Failed to parse json string"
);
define_from_err!(
rust_decimal::Error,
ErrorKind::DataInvalid,
"Failed to convert decimal literal to rust decimal"
);
define_from_err!(
parquet::errors::ParquetError,
ErrorKind::Unexpected,
"Failed to read a Parquet file"
);
define_from_err!(
futures::channel::mpsc::SendError,
ErrorKind::Unexpected,
"Failed to send a message to a channel"
);
define_from_err!(
arrow_schema::ArrowError,
ErrorKind::Unexpected,
"Arrow Schema Error"
);
define_from_err!(std::io::Error, ErrorKind::Unexpected, "IO Operation failed");
/// Converts a timestamp in milliseconds to `DateTime<Utc>`, handling errors.
///
/// # Arguments
///
/// * `timestamp_ms` - The timestamp in milliseconds to convert.
///
/// # Returns
///
/// This function returns a `Result<DateTime<Utc>, Error>` which is `Ok` with the `DateTime<Utc>` if the conversion is successful,
/// or an `Err` with an appropriate error if the timestamp is ambiguous or invalid.
pub(crate) fn timestamp_ms_to_utc(timestamp_ms: i64) -> Result<DateTime<Utc>> {
match Utc.timestamp_millis_opt(timestamp_ms) {
chrono::LocalResult::Single(t) => Ok(t),
chrono::LocalResult::Ambiguous(_, _) => Err(Error::new(
ErrorKind::Unexpected,
"Ambiguous timestamp with two possible results",
)),
chrono::LocalResult::None => Err(Error::new(ErrorKind::DataInvalid, "Invalid timestamp")),
}
.map_err(|e| e.with_context("timestamp value", timestamp_ms.to_string()))
}
/// Helper macro to check arguments.
///
///
/// Example:
///
/// Following example check `a > 0`, otherwise returns an error.
/// ```ignore
/// use iceberg::check;
/// ensure_data_valid!(a > 0, "{} is not positive.", a);
/// ```
#[macro_export]
macro_rules! ensure_data_valid {
($cond: expr, $fmt: literal, $($arg:tt)*) => {
if !$cond {
return Err($crate::error::Error::new($crate::error::ErrorKind::DataInvalid, format!($fmt, $($arg)*)))
}
};
}
#[cfg(test)]
mod tests {
use anyhow::anyhow;
use pretty_assertions::assert_eq;
use super::*;
fn generate_error_with_backtrace_disabled() -> Error {
Error::new(
ErrorKind::Unexpected,
"something wrong happened".to_string(),
)
.with_context("path", "/path/to/file".to_string())
.with_context("called", "send_async".to_string())
.with_source(anyhow!("networking error"))
.with_backtrace(Backtrace::disabled())
}
fn generate_error_with_backtrace_enabled() -> Error {
Error::new(
ErrorKind::Unexpected,
"something wrong happened".to_string(),
)
.with_context("path", "/path/to/file".to_string())
.with_context("called", "send_async".to_string())
.with_source(anyhow!("networking error"))
.with_backtrace(Backtrace::force_capture())
}
#[test]
fn test_error_display_without_backtrace() {
let s = format!("{}", generate_error_with_backtrace_disabled());
assert_eq!(
s,
r#"Unexpected, context: { path: /path/to/file, called: send_async } => something wrong happened, source: networking error"#
)
}
#[test]
fn test_error_display_with_backtrace() {
let s = format!("{}", generate_error_with_backtrace_enabled());
assert_eq!(
s,
r#"Unexpected, context: { path: /path/to/file, called: send_async } => something wrong happened, source: networking error"#
)
}
#[test]
fn test_error_debug_without_backtrace() {
let s = format!("{:?}", generate_error_with_backtrace_disabled());
assert_eq!(
s,
r#"Unexpected => something wrong happened
Context:
path: /path/to/file
called: send_async
Source: networking error
"#
)
}
/// Backtrace contains build information, so we just assert the header of error content.
#[test]
fn test_error_debug_with_backtrace() {
let s = format!("{:?}", generate_error_with_backtrace_enabled());
let expected = r#"Unexpected => something wrong happened
Context:
path: /path/to/file
called: send_async
Source: networking error
Backtrace:
0:"#;
assert_eq!(&s[..expected.len()], expected,);
}
}