feat: add Blueprint-callable SetAttribute/RemoveAttribute (#138)

Author: bobbyg603

README.md

@@ -281,6 +281,26 @@ void UMyUnrealCrasherGameInstance::Init()
 
 </details>
 
+#### Attributes (iOS and Android)
+
+The BugSplat plugin automatically adds several attributes from the crash context at initialization time. These attributes are not updated automatically after initialization. If you'd like to update them or add new ones, use the `SetAttribute` and `RemoveAttribute` functions.
+
+To call `SetAttribute` from C++, add `BugSplatRuntime` to your module's `PrivateDependencyModuleNames` in your `.Build.cs` file:
+
+```csharp
+PrivateDependencyModuleNames.AddRange(new string[] { "BugSplatRuntime" });
+```
+
+Then include the header and call `SetAttribute`:
+
+```cpp
+#include "BugSplatAttributes.h"
+
+UBugSplatAttributes::SetAttribute(TEXT("userId"), TEXT("12345"));
+```
+
+`SetAttribute` is also available as a Blueprint node under the BugSplat category.
+
 ### Xbox and PlayStation
 
 BugSplat can provide instructions for implementing Unreal crash reporting on Xbox and PlayStation. Please email us at [support@bugsplat.com](mailto:support@bugsplat.com) for more info.

Source/BugSplatRuntime/Private/BugSplatAttributes.cpp

@@ -0,0 +1,70 @@
+// Copyright BugSplat. All Rights Reserved.
+
+#include "BugSplatAttributes.h"
+#include "GenericPlatform/GenericPlatformCrashContext.h"
+
+#if PLATFORM_IOS
+#import <BugSplat/BugSplat.h>
+#endif
+
+#if PLATFORM_ANDROID
+#include "Android/AndroidJNI.h"
+#include "Android/AndroidApplication.h"
+#include "Android/AndroidJava.h"
+#endif
+
+DEFINE_LOG_CATEGORY_STATIC(LogBugSplatAttributes, Log, All);
+
+void UBugSplatAttributes::SetAttribute(const FString& Key, const FString& Value)
+{
+	if (Key.IsEmpty())
+	{
+		UE_LOG(LogBugSplatAttributes, Warning, TEXT("SetAttribute called with empty key"));
+		return;
+	}
+
+#if PLATFORM_IOS
+	NSString* NsKey = [NSString stringWithUTF8String:TCHAR_TO_UTF8(*Key)];
+	NSString* NsValue = [NSString stringWithUTF8String:TCHAR_TO_UTF8(*Value)];
+	[[BugSplat shared] setValue:NsValue forAttribute:NsKey];
+#elif PLATFORM_ANDROID
+	JNIEnv* Env = FAndroidApplication::GetJavaEnv();
+	jclass BugSplatClass = FAndroidApplication::FindJavaClass("com/bugsplat/android/BugSplat");
+	jmethodID SetAttributeMethod = FJavaWrapper::FindStaticMethod(Env, BugSplatClass, "setAttribute",
+		"(Ljava/lang/String;Ljava/lang/String;)V", false);
+	Env->CallStaticVoidMethod(BugSplatClass, SetAttributeMethod,
+		*FJavaClassObject::GetJString(Key),
+		*FJavaClassObject::GetJString(Value));
+	Env->DeleteLocalRef(BugSplatClass);
+#else
+	FGenericCrashContext::SetGameData(Key, Value);
+#endif
+
+	UE_LOG(LogBugSplatAttributes, Verbose, TEXT("SetAttribute: %s"), *Key);
+}
+
+void UBugSplatAttributes::RemoveAttribute(const FString& Key)
+{
+	if (Key.IsEmpty())
+	{
+		UE_LOG(LogBugSplatAttributes, Warning, TEXT("RemoveAttribute called with empty key"));
+		return;
+	}
+
+#if PLATFORM_IOS
+	NSString* NsKey = [NSString stringWithUTF8String:TCHAR_TO_UTF8(*Key)];
+	[[BugSplat shared] setValue:nil forAttribute:NsKey];
+#elif PLATFORM_ANDROID
+	JNIEnv* Env = FAndroidApplication::GetJavaEnv();
+	jclass BugSplatClass = FAndroidApplication::FindJavaClass("com/bugsplat/android/BugSplat");
+	jmethodID RemoveAttributeMethod = FJavaWrapper::FindStaticMethod(Env, BugSplatClass, "removeAttribute",
+		"(Ljava/lang/String;)V", false);
+	Env->CallStaticVoidMethod(BugSplatClass, RemoveAttributeMethod,
+		*FJavaClassObject::GetJString(Key));
+	Env->DeleteLocalRef(BugSplatClass);
+#else
+	FGenericCrashContext::SetGameData(Key, TEXT(""));
+#endif
+
+	UE_LOG(LogBugSplatAttributes, Verbose, TEXT("RemoveAttribute: %s"), *Key);
+}

Source/BugSplatRuntime/Public/BugSplatAttributes.h

@@ -0,0 +1,34 @@
+// Copyright BugSplat. All Rights Reserved.
+
+#pragma once
+
+#include "Kismet/BlueprintFunctionLibrary.h"
+#include "BugSplatAttributes.generated.h"
+
+UCLASS()
+class BUGSPLATRUNTIME_API UBugSplatAttributes : public UBlueprintFunctionLibrary
+{
+	GENERATED_BODY()
+
+public:
+	/**
+	 * Set a custom attribute that will be included in crash reports.
+	 * Can be called at any time after BugSplat has been initialized.
+	 *
+	 * On Windows/macOS/Linux this sets game data on the crash context.
+	 * On iOS/Android this sets the attribute on the native BugSplat SDK.
+	 *
+	 * @param Key   The attribute key.
+	 * @param Value The attribute value.
+	 */
+	UFUNCTION(BlueprintCallable, Category = "BugSplat")
+	static void SetAttribute(const FString& Key, const FString& Value);
+
+	/**
+	 * Remove a custom attribute so it is no longer included in crash reports.
+	 *
+	 * @param Key The attribute key to remove.
+	 */
+	UFUNCTION(BlueprintCallable, Category = "BugSplat")
+	static void RemoveAttribute(const FString& Key);
+};