feat: Add Windows support to debug-images (#366)

getsentry · Oct 18, 2021 · 2308e77 · 2308e77
1 parent 9e0cb22
commit 2308e77
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 19 deletions.
diff --git a/sentry-core/src/session.rs b/sentry-core/src/session.rs
@@ -40,7 +40,7 @@ impl Session {
     pub fn from_stack(stack: &StackLayer) -> Option<Self> {
         let client = stack.client.as_ref()?;
         let options = client.options();
-        let user = stack.scope.user.as_ref();
+        let user = stack.scope.user.as_deref();
         let distinct_id = user
             .and_then(|user| {
                 user.id

diff --git a/sentry-debug-images/Cargo.toml b/sentry-debug-images/Cargo.toml
@@ -14,4 +14,4 @@ edition = "2018"
 [dependencies]
 sentry-core = { version = "0.23.0", path = "../sentry-core" }
 lazy_static = "1.4.0"
-findshlibs = "0.8.0"
+findshlibs = "0.9.0"
diff --git a/sentry-debug-images/src/unix.rs → sentry-debug-images/src/images.rs b/sentry-debug-images/src/unix.rs → sentry-debug-images/src/images.rs
@@ -1,8 +1,7 @@
 use std::env;
 
-use sentry_core::protocol::debugid::DebugId;
 use sentry_core::protocol::{DebugImage, SymbolicDebugImage};
-use sentry_core::types::Uuid;
+use sentry_core::types::{CodeId, DebugId, Uuid};
 
 use findshlibs::{SharedLibrary, SharedLibraryId, TargetSharedLibrary, TARGET_SUPPORTED};
 
@@ -40,9 +39,11 @@ pub fn debug_images() -> Vec<DebugImage> {
     }
 
     TargetSharedLibrary::each(|shlib| {
-        let maybe_debug_id = shlib.id().and_then(|id| match id {
+        let maybe_debug_id = shlib.debug_id().and_then(|id| match id {
             SharedLibraryId::Uuid(bytes) => Some(DebugId::from_uuid(Uuid::from_bytes(bytes))),
             SharedLibraryId::GnuBuildId(ref id) => debug_id_from_build_id(id),
+            SharedLibraryId::PdbSignature(guid, age) => DebugId::from_guid_age(&guid, age).ok(),
+            _ => None,
         });
 
         let debug_id = match maybe_debug_id {
@@ -57,14 +58,19 @@ pub fn debug_images() -> Vec<DebugImage> {
                 .unwrap_or_else(|_| "<main>".to_string());
         }
 
+        let code_id = shlib.id().map(|id| CodeId::new(format!("{}", id)));
+        let debug_name = shlib.debug_name().map(|n| n.to_string_lossy().to_string());
+
         images.push(
             SymbolicDebugImage {
+                id: debug_id,
                 name,
                 arch: None,
                 image_addr: shlib.actual_load_addr().0.into(),
                 image_size: shlib.len() as u64,
                 image_vmaddr: shlib.stated_load_addr().0.into(),
-                id: debug_id,
+                code_id,
+                debug_file: debug_name,
             }
             .into(),
         );

diff --git a/sentry-debug-images/src/lib.rs b/sentry-debug-images/src/lib.rs
@@ -24,17 +24,8 @@
 #![warn(missing_docs)]
 #![deny(unsafe_code)]
 
-#[cfg(unix)]
-mod unix;
-
-#[cfg(unix)]
-use unix::debug_images;
-
-#[cfg(not(unix))]
-fn debug_images() -> Vec<sentry_core::protocol::DebugImage> {
-    vec![]
-}
-
+mod images;
 mod integration;
 
+use images::debug_images;
 pub use integration::DebugImagesIntegration;
diff --git a/sentry-types/src/protocol/v7.rs b/sentry-types/src/protocol/v7.rs
@@ -14,7 +14,7 @@ use std::net::{AddrParseError, IpAddr};
 use std::ops;
 use std::str;
 
-use ::debugid::DebugId;
+use ::debugid::{CodeId, DebugId};
 use chrono::{DateTime, Utc};
 use serde::Serializer;
 use serde::{Deserialize, Serialize};
@@ -40,7 +40,7 @@ pub mod map {
 
 /// Represents a debug ID.
 pub mod debugid {
-    pub use debugid::{BreakpadFormat, DebugId, ParseDebugIdError};
+    pub use debugid::{BreakpadFormat, CodeId, DebugId, ParseDebugIdError};
 }
 
 /// An arbitrary (JSON) value.
@@ -987,6 +987,13 @@ pub struct SymbolicDebugImage {
     pub image_vmaddr: Addr,
     /// The unique debug id of the image.
     pub id: DebugId,
+
+    /// Identifier of the executable file.
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub code_id: Option<CodeId>,
+    /// Name / File of the debug file.
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub debug_file: Option<String>,
 }
 
 /// Represents a proguard mapping file reference.

diff --git a/sentry-types/tests/test_protocol_v7.rs b/sentry-types/tests/test_protocol_v7.rs
@@ -767,6 +767,8 @@ mod test_debug_meta {
                         image_size: 4096,
                         image_vmaddr: 32768.into(),
                         id: "494f3aea-88fa-4296-9644-fa8ef5d139b6-1234".parse().unwrap(),
+                        code_id: None,
+                        debug_file: None,
                     }
                     .into(),
                     v7::ProguardDebugImage {