feat: consolidate the sentry middlwares into autopush_common

via the ReportableError trait

SYNC-3825

autoconnect/autoconnect-web/src/lib.rs

@@ -23,12 +23,11 @@ macro_rules! build_app {
                 actix_http::StatusCode::NOT_FOUND,
                 autopush_common::errors::render_404,
             ))
-            /*
-            .wrap(crate::middleware::sentry::SentryWrapper::new(
-                $app_state.metrics.clone(),
-                "error".to_owned(),
+            .wrap(autopush_common::middleware::sentry::SentryWrapper::<
+                autopush_common::errors::ApcError,
+            >::new(
+                $app_state.metrics.clone(), "error".to_owned()
             ))
-                */
             .configure(config)
     };
 }

autoconnect/src/main.rs

@@ -17,10 +17,6 @@ use autopush_common::{
     logging,
 };
 
-mod middleware;
-
-pub type LocalError = autopush_common::errors::ApcError;
-
 const USAGE: &str = "
 Usage: autopush_rs [options]
 
@@ -79,21 +75,14 @@ async fn main() -> Result<()> {
         "Starting autoconnect on port {} (router_port: {})",
         port, router_port
     );
-    HttpServer::new(move || {
-        let app = build_app!(app_state);
-        // TODO: should live in build_app!
-        app.wrap(crate::middleware::sentry::SentryWrapper::new(
-            app_state.metrics.clone(),
-            "error".to_owned(),
-        ))
-    })
-    .bind(("0.0.0.0", port))?
-    .bind(("0.0.0.0", router_port))?
-    .run()
-    .await
-    .map_err(|e| e.into())
-    .map(|v| {
-        info!("Shutting down autoconnect");
-        v
-    })
+    HttpServer::new(move || build_app!(app_state))
+        .bind(("0.0.0.0", port))?
+        .bind(("0.0.0.0", router_port))?
+        .run()
+        .await
+        .map_err(|e| e.into())
+        .map(|v| {
+            info!("Shutting down autoconnect");
+            v
+        })
 }

autoendpoint/src/error.rs

@@ -18,7 +18,7 @@ use std::fmt::{self, Display};
 use thiserror::Error;
 use validator::{ValidationErrors, ValidationErrorsKind};
 
-use autopush_common::db::error::DbError;
+use autopush_common::{db::error::DbError, errors::ReportableError};
 
 /// Common `Result` type.
 pub type ApiResult<T> = Result<T, ApiError>;
@@ -331,6 +331,20 @@ impl Serialize for ApiError {
     }
 }
 
+impl ReportableError for ApiError {
+    fn backtrace(&self) -> Option<&Backtrace> {
+        Some(&self.backtrace)
+    }
+
+    fn is_sentry_event(&self) -> bool {
+        self.kind.is_sentry_event()
+    }
+
+    fn metric_label(&self) -> Option<&'static str> {
+        self.kind.metric_label()
+    }
+}
+
 /// Get the error number from validation errors. If multiple errors are present,
 /// the first one with a valid error code is used.
 fn errno_from_validation_errors(e: &ValidationErrors) -> Option<usize> {

autoendpoint/src/main.rs

@@ -9,7 +9,6 @@ mod error;
 mod extractors;
 mod headers;
 mod metrics;
-mod middleware;
 mod routers;
 mod routes;
 mod server;
@@ -21,8 +20,6 @@ use std::error::Error;
 
 use autopush_common::logging;
 
-pub type LocalError = crate::error::ApiError;
-
 const USAGE: &str = "
 Usage: autoendpoint [options]
 

autoendpoint/src/server.rs

@@ -11,7 +11,10 @@ use cadence::StatsdClient;
 use fernet::MultiFernet;
 use serde_json::json;
 
-use autopush_common::db::{client::DbClient, dynamodb::DdbClientImpl, DbSettings, StorageType};
+use autopush_common::{
+    db::{client::DbClient, dynamodb::DdbClientImpl, DbSettings, StorageType},
+    middleware::sentry::SentryWrapper,
+};
 
 use crate::error::{ApiError, ApiErrorKind, ApiResult};
 use crate::metrics;
@@ -126,7 +129,7 @@ impl Server {
                 // Middleware
                 .wrap(ErrorHandlers::new().handler(StatusCode::NOT_FOUND, ApiError::render_404))
                 // Our modified Sentry wrapper which does some blocking of non-reportable errors.
-                .wrap(crate::middleware::sentry::SentryWrapper::new(
+                .wrap(SentryWrapper::<ApiError>::new(
                     metrics.clone(),
                     "api_error".to_owned(),
                 ))

autopush-common/src/errors.rs

@@ -171,15 +171,15 @@ impl ApcErrorKind {
         }
     }
 
-    pub fn metric_label(&self) -> Option<String> {
+    pub fn metric_label(&self) -> Option<&'static str> {
         // TODO: add labels for skipped stuff
         let label = match self {
             Self::PongTimeout => "pong_timeout",
             Self::ExcessivePing => "excessive_ping",
             Self::PayloadError(_) => "payload",
             _ => return None,
         };
-        Some(label.to_owned())
+        Some(label)
     }
 }
 
@@ -195,3 +195,17 @@ pub trait ReportableError: std::error::Error + fmt::Display {
     /// increment metric instead with this label
     fn metric_label(&self) -> Option<&'static str>;
 }
+
+impl ReportableError for ApcError {
+    fn backtrace(&self) -> Option<&Backtrace> {
+        Some(&self.backtrace)
+    }
+
+    fn is_sentry_event(&self) -> bool {
+        self.kind.is_sentry_event()
+    }
+
+    fn metric_label(&self) -> Option<&'static str> {
+        self.kind.metric_label()
+    }
+}

autopush-common/src/lib.rs

@@ -11,6 +11,7 @@ pub mod endpoint;
 pub mod errors;
 pub mod logging;
 pub mod metrics;
+pub mod middleware;
 pub mod notification;
 pub mod sentry;
 pub mod tags;

autopush-common/src/middleware/mod.rs

@@ -0,0 +1 @@
+pub mod sentry;