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

//! Adds support for the error-chain crate.
//!
//! Errors created by the `error-chain` crate can be logged with the
//! `error_chain` integration.
//!
//! # Example
//!
//! ```no_run
//! # #[macro_use] extern crate error_chain;
//!
//! use ckb_sentry_error_chain as sentry_error_chain;
//!
//! # error_chain! {}
//! use sentry_error_chain::{capture_error_chain, ErrorChainIntegration};
//! # fn function_that_might_fail() -> Result<()> { Ok(()) }
//! # fn test() -> Result<()> {
//! let _sentry =
//!     sentry::init(sentry::ClientOptions::default().add_integration(ErrorChainIntegration));
//! let result = match function_that_might_fail() {
//!     Ok(result) => result,
//!     Err(err) => {
//!         capture_error_chain(&err);
//!         return Err(err);
//!     }
//! };
//! # Ok(()) }
//! ```

#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
#![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
#![warn(missing_docs)]
#![deny(unsafe_code)]
#![allow(deprecated)]

use std::fmt::{Debug, Display};

use error_chain::ChainedError;
use sentry_backtrace::backtrace_to_stacktrace;
use sentry_core::parse_type_from_debug;
use sentry_core::protocol::{Event, Exception, Level};
use sentry_core::types::Uuid;
use sentry_core::{ClientOptions, Hub, Integration};

fn exceptions_from_error_chain<T>(error: &T) -> Vec<Exception>
where
    T: ChainedError,
    T::ErrorKind: Debug + Display,
{
    let dbg = format!("{:?}", error.kind());
    let mut rv = vec![];
    rv.push(Exception {
        ty: parse_type_from_debug(&dbg).to_owned(),
        value: Some(error.kind().to_string()),
        stacktrace: error_chain::ChainedError::backtrace(error).and_then(backtrace_to_stacktrace),
        ..Default::default()
    });

    for error in error.iter().skip(1) {
        let dbg = format!("{:?}", error);
        rv.push(Exception {
            ty: parse_type_from_debug(&dbg).to_owned(),
            value: Some(error.to_string()),
            ..Default::default()
        })
    }

    rv
}

/// Creates an event from an error chain.
#[deprecated = "The `error_chain` integration is deprecated and will be removed in the future."]
pub fn event_from_error_chain<T>(e: &T) -> Event<'static>
where
    T: ChainedError,
    T::ErrorKind: Debug + Display,
{
    Event {
        exception: exceptions_from_error_chain(e).into(),
        level: Level::Error,
        ..Default::default()
    }
}

/// Captures an error chain.
#[deprecated = "The `error_chain` integration is deprecated and will be removed in the future."]
pub fn capture_error_chain<T>(e: &T) -> Uuid
where
    T: ChainedError,
    T::ErrorKind: Debug + Display,
{
    Hub::with_active(|hub| hub.capture_error_chain(e))
}

/// Hub extension methods for working with error chain
#[deprecated = "The `error_chain` integration is deprecated and will be removed in the future."]
pub trait ErrorChainHubExt {
    /// Captures an error chain on a specific hub.
    fn capture_error_chain<T>(&self, e: &T) -> Uuid
    where
        T: ChainedError,
        T::ErrorKind: Debug + Display;
}

impl ErrorChainHubExt for Hub {
    fn capture_error_chain<T>(&self, e: &T) -> Uuid
    where
        T: ChainedError,
        T::ErrorKind: Debug + Display,
    {
        self.capture_event(event_from_error_chain(e))
    }
}

/// The Sentry `error-chain` Integration.
#[derive(Debug, Default)]
#[deprecated = "The `error_chain` integration is deprecated and will be removed in the future."]
pub struct ErrorChainIntegration;

impl ErrorChainIntegration {
    /// Creates a new `error-chain` Integration.
    pub fn new() -> Self {
        Self::default()
    }
}

impl Integration for ErrorChainIntegration {
    fn name(&self) -> &'static str {
        "error-chain"
    }

    fn setup(&self, cfg: &mut ClientOptions) {
        cfg.in_app_exclude.push("error_chain::");
        cfg.extra_border_frames.push("error_chain::make_backtrace");
    }
}