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

// Copyright 2018 foundationdb-rs developers, https://github.com/bluejekyll/foundationdb-rs/graphs/contributors
// Copyright 2013-2018 Apple, Inc and the FoundationDB project authors.
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! Error types for the Fdb crate

use std;
use std::ffi::CStr;
use std::fmt::{self, Display};

use failure::{Backtrace, Context, Fail};

use foundationdb_sys as fdb_sys;
use options;
use tuple;

pub(crate) fn eval(error_code: fdb_sys::fdb_error_t) -> Result<()> {
    let rust_code = error_code as i32;
    if rust_code == 0 {
        Ok(())
    } else {
        Err(Error::from(error_code))
    }
}

/// The Standard Error type of FoundationDB
#[derive(Debug)]
pub struct Error {
    kind: Context<ErrorKind>,
    // Not all retryable error should be retried. For example, error_code=1020 transaction conflict
    // error is always retryable (so `Error::is_retryable` always returns `true`), while it
    // should not be retried if `TransactionOption::RetryLimit` is exceeded. So we should keep
    // track whether the error should be retried or not.
    should_retry: bool,
}

/// An error from Fdb with associated code and message
#[derive(Debug, Fail)]
pub enum ErrorKind {
    /// Errors that originate from the FoundationDB layers
    #[fail(display = "FoundationDB error({}): {}", error_code, error_str)]
    Fdb {
        /// The FoundationDB error code
        error_code: i32,
        /// The error string as defined by FoundationDB
        error_str: &'static str,
    },
    /// Encoding/Decoding errors related to Tuple
    #[fail(display = "Internal error with tuple encoding/decoding: {}", error)]
    Tuple {
        /// The cause of this error
        error: tuple::Error,
    },
}

/// An Fdb Result type
pub type Result<T> = std::result::Result<T, Error>;

impl Fail for Error {
    fn cause(&self) -> Option<&Fail> {
        self.kind.cause()
    }

    fn backtrace(&self) -> Option<&Backtrace> {
        self.kind.backtrace()
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        Display::fmt(&self.kind, f)
    }
}

impl From<tuple::Error> for Error {
    fn from(error: tuple::Error) -> Self {
        Error {
            kind: Context::new(ErrorKind::Tuple { error }),
            should_retry: false,
        }
    }
}

impl Error {
    /// Converts from the raw Fdb error code into an `Error`
    pub fn from(error_code: fdb_sys::fdb_error_t) -> Self {
        let error_str = unsafe { CStr::from_ptr(fdb_sys::fdb_get_error(error_code)) };

        Error {
            kind: Context::new(ErrorKind::Fdb {
                error_code: error_code as i32,
                error_str: error_str
                    .to_str()
                    .expect("bad error string from FoundationDB"),
            }),
            should_retry: false,
        }
    }

    /// Indicates the transaction may have succeeded, though not in a way the system can verify.
    pub fn is_maybe_committed(&self) -> bool {
        match *self.kind.get_context() {
            ErrorKind::Fdb { error_code, .. } => {
                let check = unsafe {
                    fdb_sys::fdb_error_predicate(
                        options::ErrorPredicate::MaybeCommitted.code() as i32,
                        error_code,
                    ) as i32
                };

                check != 0
            }
            _ => false,
        }
    }

    /// Indicates the operations in the transactions should be retried because of transient error.
    pub fn is_retryable(&self) -> bool {
        match *self.kind.get_context() {
            ErrorKind::Fdb { error_code, .. } => {
                let check = unsafe {
                    fdb_sys::fdb_error_predicate(
                        options::ErrorPredicate::Retryable.code() as i32,
                        error_code,
                    ) as i32
                };

                check != 0
            }
            _ => false,
        }
    }

    /// Indicates the transaction has not committed, though in a way that can be retried.
    pub fn is_retryable_not_committed(&self) -> bool {
        match *self.kind.get_context() {
            ErrorKind::Fdb { error_code, .. } => {
                let check = unsafe {
                    fdb_sys::fdb_error_predicate(
                        options::ErrorPredicate::RetryableNotCommitted.code() as i32,
                        error_code,
                    ) as i32
                };

                check != 0
            }
            _ => false,
        }
    }

    /// Error code
    pub fn code(&self) -> i32 {
        match *self.kind.get_context() {
            ErrorKind::Fdb { error_code, .. } => error_code,
            _ => 4000,
        }
    }

    pub(crate) fn set_should_retry(&mut self, should_retry: bool) {
        self.should_retry = should_retry;
    }

    pub(crate) fn should_retry(&self) -> bool {
        self.should_retry
    }
}