fix: Sync breadcrumb data to native layer

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- The SDK now also syncs breadcrumb data to the native layer so they are available on events coming from the native SDKs ([#2720](https://github.com/getsentry/sentry-unity/pull/2720))
 - Removed `Lumin` and `Stadia` platforms from the package's assembly definition to resolve compilation errors. ([#2716](https://github.com/getsentry/sentry-unity/pull/2716))
 
 ### Features

package-dev/Plugins/iOS/SentryNativeBridge.m

@@ -107,8 +107,8 @@ void SentryNativeBridgeSetSdkName()
 
 void SentryNativeBridgeClose() { [SentrySDK close]; }
 
-void SentryNativeBridgeAddBreadcrumb(
-    const char *timestamp, const char *message, const char *type, const char *category, int level)
+void SentryNativeBridgeAddBreadcrumb(const char *timestamp, const char *message, const char *type,
+    const char *category, int level, const char **dataKeys, const char **dataValues, int dataCount)
 {
     if (timestamp == NULL && message == NULL && type == NULL && category == NULL) {
         return;
@@ -139,6 +139,18 @@ void SentryNativeBridgeAddBreadcrumb(
             breadcrumb.type = typeString;
         }
 
+        if (dataCount > 0 && dataKeys != NULL && dataValues != NULL) {
+            NSMutableDictionary *data = [NSMutableDictionary dictionaryWithCapacity:dataCount];
+            for (int i = 0; i < dataCount; i++) {
+                NSString *key = _NSStringOrNil(dataKeys[i]);
+                NSString *value = _NSStringOrNil(dataValues[i]);
+                if (key != nil && value != nil) {
+                    data[key] = value;
+                }
+            }
+            breadcrumb.data = data;
+        }
+
         [scope addBreadcrumb:breadcrumb];
     }];
 }

package-dev/Plugins/iOS/SentryNativeBridgeNoOp.m

@@ -16,8 +16,8 @@ void SentryNativeBridgeSetSdkName() { }
 
 void SentryNativeBridgeClose() { }
 
-void SentryNativeBridgeAddBreadcrumb(
-    const char *timestamp, const char *message, const char *type, const char *category, int level) { }
+void SentryNativeBridgeAddBreadcrumb(const char *timestamp, const char *message, const char *type,
+    const char *category, int level, const char **dataKeys, const char **dataValues, int dataCount) { }
 
 void SentryNativeBridgeSetExtra(const char *key, const char *value) { }
 

package-dev/Plugins/macOS/SentryNativeBridge.m

@@ -208,8 +208,8 @@ void SentryNativeBridgeClose()
     }
 }
 
-void SentryNativeBridgeAddBreadcrumb(
-    const char *timestamp, const char *message, const char *type, const char *category, int level)
+void SentryNativeBridgeAddBreadcrumb(const char *timestamp, const char *message, const char *type,
+    const char *category, int level, const char **dataKeys, const char **dataValues, int dataCount)
 {
     if (timestamp == NULL && message == NULL && type == NULL && category == NULL) {
         return;
@@ -244,6 +244,18 @@ void SentryNativeBridgeAddBreadcrumb(
 
         [breadcrumb setValue:[NSNumber numberWithInt:level] forKey:@"level"];
 
+        if (dataCount > 0 && dataKeys != NULL && dataValues != NULL) {
+            NSMutableDictionary *data = [NSMutableDictionary dictionaryWithCapacity:dataCount];
+            for (int i = 0; i < dataCount; i++) {
+                NSString *key = _NSStringOrNil(dataKeys[i]);
+                NSString *value = _NSStringOrNil(dataValues[i]);
+                if (key != nil && value != nil) {
+                    data[key] = value;
+                }
+            }
+            [breadcrumb setValue:data forKey:@"data"];
+        }
+
         [scope performSelector:@selector(addBreadcrumb:) withObject:breadcrumb];
     });
 }

src/Sentry.Unity.Android/SentryJava.cs

@@ -304,6 +304,13 @@ public void AddBreadcrumb(Breadcrumb breadcrumb)
             javaBreadcrumb.Set("category", breadcrumb.Category);
             using var javaLevel = breadcrumb.Level.ToJavaSentryLevel();
             javaBreadcrumb.Set("level", javaLevel);
+            if (breadcrumb.Data is { Count: > 0 })
+            {
+                foreach (var kvp in breadcrumb.Data)
+                {
+                    javaBreadcrumb.Call("setData", kvp.Key, kvp.Value);
+                }
+            }
             sentry.CallStatic("addBreadcrumb", javaBreadcrumb, null);
         });
     }

src/Sentry.Unity.Native/NativeScopeObserver.cs

@@ -17,6 +17,15 @@ public override void AddBreadcrumbImpl(Breadcrumb breadcrumb)
         C.sentry_value_set_by_key(crumb, "level", C.sentry_value_new_string(breadcrumb.Level.ToString().ToLower()));
         C.sentry_value_set_by_key(crumb, "timestamp", C.sentry_value_new_string(GetTimestamp(breadcrumb.Timestamp)));
         C.SetValueIfNotNull(crumb, "category", breadcrumb.Category);
+        if (breadcrumb.Data is { Count: > 0 })
+        {
+            var data = C.sentry_value_new_object();
+            foreach (var kvp in breadcrumb.Data)
+            {
+                C.SetValueIfNotNull(data, kvp.Key, kvp.Value);
+            }
+            _ = C.sentry_value_set_by_key(crumb, "data", data);
+        }
         C.sentry_add_breadcrumb(crumb);
     }
 

src/Sentry.Unity.iOS/NativeScopeObserver.cs

@@ -11,7 +11,33 @@ public override void AddBreadcrumbImpl(Breadcrumb breadcrumb)
         var level = GetBreadcrumbLevel(breadcrumb.Level);
         var timestamp = GetTimestamp(breadcrumb.Timestamp);
 
-        SentryCocoaBridgeProxy.AddBreadcrumb(timestamp, breadcrumb.Message, breadcrumb.Type, breadcrumb.Category, level);
+        // Pass breadcrumb.Data as two parallel key/value arrays for the __Internal P/Invoke boundary.
+        var dataCount = GetBreadcrumbData(breadcrumb, out var dataKeys, out var dataValues);
+
+        SentryCocoaBridgeProxy.AddBreadcrumb(timestamp, breadcrumb.Message, breadcrumb.Type, breadcrumb.Category, level,
+            dataKeys, dataValues, dataCount);
+    }
+
+    internal static int GetBreadcrumbData(Breadcrumb breadcrumb, out string[]? keys, out string[]? values)
+    {
+        if (breadcrumb.Data is not { Count: > 0 } data)
+        {
+            keys = null;
+            values = null;
+            return 0;
+        }
+
+        keys = new string[data.Count];
+        values = new string[data.Count];
+        var i = 0;
+        foreach (var kvp in data)
+        {
+            keys[i] = kvp.Key;
+            values[i] = kvp.Value;
+            i++;
+        }
+
+        return data.Count;
     }
 
     public override void SetExtraImpl(string key, string? value) =>

src/Sentry.Unity.iOS/SentryCocoaBridgeProxy.cs

@@ -128,7 +128,8 @@ public static bool Init(SentryUnityOptions options)
     public static extern void Close();
 
     [DllImport("__Internal", EntryPoint = "SentryNativeBridgeAddBreadcrumb")]
-    public static extern void AddBreadcrumb(string timestamp, string? message, string? type, string? category, int level);
+    public static extern void AddBreadcrumb(string timestamp, string? message, string? type, string? category, int level,
+        string[]? dataKeys, string[]? dataValues, int dataCount);
 
     [DllImport("__Internal", EntryPoint = "SentryNativeBridgeSetExtra")]
     public static extern void SetExtra(string key, string? value);

test/IntegrationTest/CommonTestCases.ps1

@@ -72,6 +72,10 @@ $CommonTestCases = @(
             $SentryEvent.breadcrumbs.values | Should -Not -BeNullOrEmpty
             $SentryEvent.breadcrumbs.values | Where-Object { $_.message -eq "Integration test started" } | Should -Not -BeNullOrEmpty
             $SentryEvent.breadcrumbs.values | Where-Object { $_.message -eq "Context configuration finished" } | Should -Not -BeNullOrEmpty
+
+            $dataCrumb = $SentryEvent.breadcrumbs.values | Where-Object { $_.message -eq "Context configuration finished" }
+            $dataCrumb | Should -Not -BeNullOrEmpty
+            $dataCrumb.data.integration_test_key | Should -Be "integration_test_value"
         }
     }
     @{ Name = "Contains SDK information"; TestBlock = {

test/Scripts.Integration.Test/Scripts/IntegrationTester.cs

@@ -98,7 +98,10 @@ private void AddIntegrationTestContext(string testType)
             };
         });
 
-        SentrySdk.AddBreadcrumb("Context configuration finished");
+        SentrySdk.AddBreadcrumb("Context configuration finished", data: new Dictionary<string, string>
+        {
+            { "integration_test_key", "integration_test_value" }
+        });
     }
 
     private IEnumerator MessageCapture()

test/Sentry.Unity.iOS.Tests/NativeScopeObserverTests.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Globalization;
 using NUnit.Framework;
 
@@ -29,4 +30,36 @@ public void GetBreadcrumbLevel_TestCases(BreadcrumbLevel level, int expectedNati
 
         Assert.AreEqual(actualLevel, expectedNativeLevel);
     }
+
+    [Test]
+    public void GetBreadcrumbData_WithData_BuildsParallelArrays()
+    {
+        var breadcrumb = new Breadcrumb("message", "type", new Dictionary<string, string>
+        {
+            { "key1", "value1" },
+            { "key2", "value2" },
+        });
+
+        var count = NativeScopeObserver.GetBreadcrumbData(breadcrumb, out var keys, out var values);
+
+        Assert.AreEqual(2, count);
+        Assert.IsNotNull(keys);
+        Assert.IsNotNull(values);
+        Assert.AreEqual("key1", keys![0]);
+        Assert.AreEqual("value1", values![0]);
+        Assert.AreEqual("key2", keys[1]);
+        Assert.AreEqual("value2", values[1]);
+    }
+
+    [Test]
+    public void GetBreadcrumbData_WithoutData_ReturnsZeroAndNullArrays()
+    {
+        var breadcrumb = new Breadcrumb("message", "type");
+
+        var count = NativeScopeObserver.GetBreadcrumbData(breadcrumb, out var keys, out var values);
+
+        Assert.AreEqual(0, count);
+        Assert.IsNull(keys);
+        Assert.IsNull(values);
+    }
 }