Add live debugger sender FFI

Signed-off-by: Bob Weinand <[email protected]>

Author: bwoebi

Cargo.lock

@@ -11,5 +11,9 @@ crate-type = ["lib", "staticlib", "cdylib"]
 
 [dependencies]
 datadog-live-debugger = { path = "../live-debugger" }
+ddcommon = { path = "../ddcommon" }
 ddcommon-ffi = { path = "../ddcommon-ffi" }
 uuid = { version = "1.7.0", features = ["v4"] }
+serde_json = "1.0"
+tokio = "1.36.0"
+log = "0.4.21"

live-debugger-ffi/Cargo.toml

@@ -4,4 +4,5 @@
 pub mod data;
 pub mod evaluator;
 pub mod parse;
+pub mod send_data;
 pub mod sender;

live-debugger-ffi/src/lib.rs

@@ -0,0 +1,321 @@
+// Copyright 2021-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+
+use ddcommon_ffi::CharSlice;
+use std::borrow::Cow;
+use std::collections::hash_map;
+use std::mem::transmute;
+// Alias to prevent cbindgen panic
+use crate::data::Probe;
+use datadog_live_debugger::debugger_defs::{
+    Capture as DebuggerCaptureAlias, Capture, Captures, DebuggerData, DebuggerPayload, Entry,
+    Fields, Snapshot, SnapshotEvaluationError, Value as DebuggerValueAlias,
+};
+use datadog_live_debugger::sender::generate_new_id;
+use ddcommon_ffi::slice::AsBytes;
+
+#[repr(C)]
+pub enum FieldType {
+    STATIC,
+    ARG,
+    LOCAL,
+}
+
+#[repr(C)]
+pub struct CaptureValue<'a> {
+    pub r#type: CharSlice<'a>,
+    pub value: CharSlice<'a>,
+    pub fields: Option<Box<Fields<'a>>>,
+    pub elements: Vec<DebuggerValue<'a>>,
+    pub entries: Vec<Entry<'a>>,
+    pub is_null: bool,
+    pub truncated: bool,
+    pub not_captured_reason: CharSlice<'a>,
+    pub size: CharSlice<'a>,
+}
+
+impl<'a> From<CaptureValue<'a>> for DebuggerValueAlias<'a> {
+    fn from(val: CaptureValue<'a>) -> Self {
+        DebuggerValueAlias {
+            r#type: val.r#type.to_utf8_lossy(),
+            value: if val.value.len() == 0 {
+                None
+            } else {
+                Some(val.value.to_utf8_lossy())
+            },
+            fields: if let Some(boxed) = val.fields {
+                *boxed
+            } else {
+                Fields::default()
+            },
+            elements: unsafe { transmute(val.elements) }, // SAFETY: is transparent
+            entries: val.entries,
+            is_null: val.is_null,
+            truncated: val.truncated,
+            not_captured_reason: if val.not_captured_reason.len() == 0 {
+                None
+            } else {
+                Some(val.not_captured_reason.to_utf8_lossy())
+            },
+            size: if val.size.len() == 0 {
+                None
+            } else {
+                Some(val.size.to_utf8_lossy())
+            },
+        }
+    }
+}
+
+/// cbindgen:no-export
+#[repr(transparent)]
+pub struct DebuggerValue<'a>(DebuggerValueAlias<'a>);
+/// cbindgen:no-export
+#[repr(transparent)]
+pub struct DebuggerCapture<'a>(DebuggerCaptureAlias<'a>);
+
+#[repr(C)]
+pub struct ExceptionSnapshot<'a> {
+    pub data: *mut DebuggerPayload<'a>,
+    pub capture: *mut DebuggerCapture<'a>,
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_create_exception_snapshot<'a>(
+    buffer: &mut Vec<DebuggerPayload<'a>>,
+    service: CharSlice<'a>,
+    language: CharSlice<'a>,
+    id: CharSlice<'a>,
+    exception_id: CharSlice<'a>,
+    timestamp: u64,
+) -> *mut DebuggerCapture<'a> {
+    let snapshot = DebuggerPayload {
+        service: service.to_utf8_lossy(),
+        source: "dd_debugger",
+        timestamp,
+        message: None,
+        debugger: DebuggerData {
+            snapshot: Snapshot {
+                captures: Some(Captures {
+                    r#return: Some(Capture::default()),
+                    ..Default::default()
+                }),
+                language: language.to_utf8_lossy(),
+                id: id.to_utf8_lossy(),
+                exception_id: Some(exception_id.to_utf8_lossy()),
+                timestamp,
+                ..Default::default()
+            },
+        },
+    };
+    buffer.push(snapshot);
+    unsafe {
+        let captures = buffer
+            .last_mut()
+            .unwrap()
+            .debugger
+            .snapshot
+            .captures
+            .as_mut();
+        transmute(captures.unwrap().r#return.as_mut().unwrap())
+    }
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_create_log_probe_snapshot<'a>(
+    probe: &'a Probe,
+    message: Option<&CharSlice<'a>>,
+    service: CharSlice<'a>,
+    language: CharSlice<'a>,
+    timestamp: u64,
+) -> Box<DebuggerPayload<'a>> {
+    Box::new(DebuggerPayload {
+        service: service.to_utf8_lossy(),
+        source: "dd_debugger",
+        timestamp,
+        message: message.map(|m| m.to_utf8_lossy()),
+        debugger: DebuggerData {
+            snapshot: Snapshot {
+                captures: Some(Captures {
+                    ..Default::default()
+                }),
+                language: language.to_utf8_lossy(),
+                id: Cow::Owned(generate_new_id().as_hyphenated().to_string()),
+                probe: Some(probe.into()),
+                timestamp,
+                ..Default::default()
+            },
+        },
+    })
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_update_payload_message<'a>(
+    payload: &mut DebuggerPayload<'a>,
+    message: CharSlice<'a>,
+) {
+    payload.message = Some(message.to_utf8_lossy());
+}
+
+#[no_mangle]
+pub unsafe extern "C" fn ddog_snapshot_entry<'a>(
+    payload: &mut DebuggerPayload<'a>,
+) -> *mut DebuggerCapture<'a> {
+    transmute(
+        payload
+            .debugger
+            .snapshot
+            .captures
+            .as_mut()
+            .unwrap()
+            .entry
+            .insert(Capture::default()),
+    )
+}
+
+#[no_mangle]
+pub unsafe extern "C" fn ddog_snapshot_lines<'a>(
+    payload: &mut DebuggerPayload<'a>,
+    line: u32,
+) -> *mut DebuggerCapture<'a> {
+    transmute(
+        match payload
+            .debugger
+            .snapshot
+            .captures
+            .as_mut()
+            .unwrap()
+            .lines
+            .entry(line)
+        {
+            hash_map::Entry::Occupied(e) => e.into_mut(),
+            hash_map::Entry::Vacant(e) => e.insert(Capture::default()),
+        },
+    )
+}
+
+#[no_mangle]
+pub unsafe extern "C" fn ddog_snapshot_exit<'a>(
+    payload: &mut DebuggerPayload<'a>,
+) -> *mut DebuggerCapture<'a> {
+    transmute(
+        payload
+            .debugger
+            .snapshot
+            .captures
+            .as_mut()
+            .unwrap()
+            .r#return
+            .as_mut()
+            .unwrap(),
+    )
+}
+
+#[no_mangle]
+#[allow(improper_ctypes_definitions)] // Vec has a fixed size, and we care only about that here
+pub extern "C" fn ddog_snapshot_add_field<'a, 'b: 'a, 'c: 'a>(
+    capture: &mut DebuggerCapture<'a>,
+    r#type: FieldType,
+    name: CharSlice<'b>,
+    value: CaptureValue<'c>,
+) {
+    let fields = match r#type {
+        FieldType::STATIC => &mut capture.0.static_fields,
+        FieldType::ARG => &mut capture.0.arguments,
+        FieldType::LOCAL => &mut capture.0.locals,
+    };
+    fields.insert(name.to_utf8_lossy(), value.into());
+}
+
+#[no_mangle]
+#[allow(improper_ctypes_definitions)] // Vec has a fixed size, and we care only about that here
+pub extern "C" fn ddog_capture_value_add_element<'a, 'b: 'a>(
+    value: &mut CaptureValue<'a>,
+    element: CaptureValue<'b>,
+) {
+    value.elements.push(DebuggerValue(element.into()));
+}
+
+#[no_mangle]
+#[allow(improper_ctypes_definitions)] // Vec has a fixed size, and we care only about that here
+pub extern "C" fn ddog_capture_value_add_entry<'a, 'b: 'a, 'c: 'a>(
+    value: &mut CaptureValue<'a>,
+    key: CaptureValue<'b>,
+    element: CaptureValue<'c>,
+) {
+    value.entries.push(Entry(key.into(), element.into()));
+}
+
+#[no_mangle]
+#[allow(improper_ctypes_definitions)] // Vec has a fixed size, and we care only about that here
+pub extern "C" fn ddog_capture_value_add_field<'a, 'b: 'a, 'c: 'a>(
+    value: &mut CaptureValue<'a>,
+    key: CharSlice<'b>,
+    element: CaptureValue<'c>,
+) {
+    let fields = match value.fields {
+        None => {
+            value.fields = Some(Box::default());
+            value.fields.as_mut().unwrap()
+        }
+        Some(ref mut f) => f,
+    };
+    fields.insert(key.to_utf8_lossy(), element.into());
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_snapshot_format_new_uuid(buf: &mut [u8; 36]) {
+    generate_new_id().as_hyphenated().encode_lower(buf);
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_evaluation_error_first_msg(vec: &Vec<SnapshotEvaluationError>) -> CharSlice {
+    CharSlice::from(vec[0].message.as_str())
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_evaluation_error_drop(_: Box<Vec<SnapshotEvaluationError>>) {}
+
+#[no_mangle]
+pub extern "C" fn ddog_evaluation_error_snapshot<'a>(
+    probe: &'a Probe,
+    service: CharSlice<'a>,
+    language: CharSlice<'a>,
+    errors: Box<Vec<SnapshotEvaluationError>>,
+    timestamp: u64,
+) -> Box<DebuggerPayload<'a>> {
+    Box::new(DebuggerPayload {
+        service: service.to_utf8_lossy(),
+        source: "dd_debugger",
+        timestamp,
+        message: Some(Cow::Owned(format!(
+            "Evaluation errors for probe id {}",
+            probe.id
+        ))),
+        debugger: DebuggerData {
+            snapshot: Snapshot {
+                language: language.to_utf8_lossy(),
+                id: Cow::Owned(generate_new_id().as_hyphenated().to_string()),
+                probe: Some(probe.into()),
+                timestamp,
+                evaluation_errors: *errors,
+                ..Default::default()
+            },
+        },
+    })
+}
+
+pub fn serialize_debugger_payload(payload: &DebuggerPayload) -> String {
+    serde_json::to_string(payload).unwrap()
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_serialize_debugger_payload(
+    payload: &DebuggerPayload,
+    callback: extern "C" fn(CharSlice),
+) {
+    let payload = serialize_debugger_payload(payload);
+    callback(CharSlice::from(payload.as_str()))
+}
+
+#[no_mangle]
+pub extern "C" fn ddog_drop_debugger_payload(_: Box<DebuggerPayload>) {}