wip(lib): minor refactoring

Author: omarabid

CHANGELOG.md

@@ -1,5 +1,14 @@
+# v0.5.4
+## New Features
+- Add report transfromation function which allows changing the report before
+  sending it to the Pyroscope Server.
+- Add Gzip support.
+
+## Bug Fixes
+- Use URL Builder. ([786c89b](https://github.com/pyroscope-io/pyroscope-rs/commit/786c89bb99839c45778410012a6da60267d395df))
+
 # v0.5.3
-## New features
+## New Features
 - Add BackendConfig to make reporting of pid, thread_id and thread_name
   optional. 
 - Backends can add a suffix to the "application_name"

pyroscope_ffi/ffikit/src/lib.rs

@@ -23,9 +23,13 @@ static ONCE: Once = Once::new();
 
 lazy_static! {
     /// Root Sender
+    /// This is the sender to the main loop. It is lazily initialized inside a Mutex.
     static ref SENDER: Mutex<Option<Sender<Signal>>> = Mutex::new(None);
 }
 
+/// Signal enum.
+/// This enum is used to send signals to the main loop. It is used to add/remove global or thread
+/// tags and to exit the main loop.
 #[derive(Debug, Encode, Decode, PartialEq, Clone)]
 pub enum Signal {
     Kill,
@@ -52,7 +56,7 @@ pub fn initialize_ffi() -> Result<Receiver<Signal>> {
 
         // Listen for signals on the main parent process.
         let fn_sender = merge_sender.clone();
-        let channel_listener: JoinHandle<Result<()>> = std::thread::spawn(move || {
+        let _channel_listener: JoinHandle<Result<()>> = std::thread::spawn(move || {
             log::trace!("Spawned FFI listener thread.");
 
             while let Ok(signal) = receiver.recv() {
@@ -81,7 +85,7 @@ pub fn initialize_ffi() -> Result<Receiver<Signal>> {
 
         // Listen for signals on local socket
         let socket_sender = merge_sender.clone();
-        let socket_listener: JoinHandle<Result<()>> = std::thread::spawn(move || {
+        let _socket_listener: JoinHandle<Result<()>> = std::thread::spawn(move || {
             let socket_address = format!("/tmp/PYROSCOPE-{}", get_parent_pid());
 
             log::trace!(
@@ -158,7 +162,16 @@ pub fn send(signal: Signal) -> Result<()> {
         conn.flush()?;
     } else {
         // Send signal through parent process.
-        SENDER.lock()?.as_ref().unwrap().send(signal)?;
+        if let Some(sender) = &*SENDER.lock()? {
+            log::trace!(
+                target: LOG_TAG,
+                "Sending signal {:?} through FFI channel",
+                signal
+            );
+            sender.send(signal)?;
+        } else {
+            log::error!(target: LOG_TAG, "FFI channel not initialized");
+        }
     }
 
     Ok(())

src/backend/backend.rs

@@ -12,25 +12,14 @@ use std::{
 use super::Report;
 
 /// Backend Config
-#[derive(Debug, Copy, Clone)]
+#[derive(Debug, Copy, Clone, Default)]
 pub struct BackendConfig {
     pub report_thread_id: bool,
     pub report_thread_name: bool,
     pub report_pid: bool,
     pub report_oncpu: bool,
 }
 
-impl Default for BackendConfig {
-    fn default() -> Self {
-        Self {
-            report_thread_id: false,
-            report_thread_name: false,
-            report_pid: false,
-            report_oncpu: false,
-        }
-    }
-}
-
 /// Backend Trait
 pub trait Backend: Send + Debug {
     /// Backend Spy Name

src/session.rs

@@ -156,7 +156,7 @@ impl Session {
         let mut report_owned = report.to_owned();
 
         // Apply function to the report
-        if let Some(func) = self.config.func.clone() {
+        if let Some(func) = self.config.func {
             report_owned = func(report_owned);
         }