Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add user feedback capturing support for desktop #521

Merged
merged 7 commits into from
Apr 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### Features

- Add user feedback capturing support for desktop ([#521](https://github.com/getsentry/sentry-unreal/pull/521))
- Add breadcrumbs automatically when printing to logs ([#522](https://github.com/getsentry/sentry-unreal/pull/522))

### Fixes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
#include "SentryBeforeSendHandler.h"
#include "SentryTraceSampler.h"
#include "SentryTransactionContext.h"
#include "SentryUserFeedbackDesktop.h"

#include "Infrastructure/SentryConvertorsDesktop.h"

Expand Down Expand Up @@ -283,7 +284,8 @@ USentryId* SentrySubsystemDesktop::CaptureEventWithScope(USentryEvent* event, co

void SentrySubsystemDesktop::CaptureUserFeedback(USentryUserFeedback* userFeedback)
{
UE_LOG(LogSentrySdk, Log, TEXT("CaptureUserFeedback method is not supported for the current platform."));
TSharedPtr<SentryUserFeedbackDesktop> userFeedbackDesktop = StaticCastSharedPtr<SentryUserFeedbackDesktop>(userFeedback->GetNativeImpl());
sentry_capture_user_feedback(userFeedbackDesktop->GetNativeObject());
}

void SentrySubsystemDesktop::SetUser(USentryUser* user)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// Copyright (c) 2022 Sentry. All Rights Reserved.

#include "SentryUserFeedbackDesktop.h"

#include "SentryId.h"

#include "Infrastructure/SentryConvertorsDesktop.h"

#if USE_SENTRY_NATIVE

SentryUserFeedbackDesktop::SentryUserFeedbackDesktop()
{
UserFeedbackDesktop = sentry_value_new_object();
}

SentryUserFeedbackDesktop::SentryUserFeedbackDesktop(USentryId* eventId)
{
UserFeedbackDesktop = sentry_value_new_object();
sentry_value_set_by_key(UserFeedbackDesktop, "event_id", sentry_value_new_string(TCHAR_TO_ANSI(*eventId->ToString())));
}

SentryUserFeedbackDesktop::~SentryUserFeedbackDesktop()
{
// Put custom destructor logic here if needed
}

sentry_value_t SentryUserFeedbackDesktop::GetNativeObject()
{
return UserFeedbackDesktop;
}

void SentryUserFeedbackDesktop::SetName(const FString& name)
{
sentry_value_set_by_key(UserFeedbackDesktop, "name", sentry_value_new_string(TCHAR_TO_ANSI(*name)));
}

FString SentryUserFeedbackDesktop::GetName() const
{
sentry_value_t username = sentry_value_get_by_key(UserFeedbackDesktop, "name");
return FString(sentry_value_as_string(username));
}

void SentryUserFeedbackDesktop::SetEmail(const FString& email)
{
sentry_value_set_by_key(UserFeedbackDesktop, "email", sentry_value_new_string(TCHAR_TO_ANSI(*email)));
}

FString SentryUserFeedbackDesktop::GetEmail() const
{
sentry_value_t email = sentry_value_get_by_key(UserFeedbackDesktop, "email");
return FString(sentry_value_as_string(email));
}

void SentryUserFeedbackDesktop::SetComment(const FString& comment)
{
sentry_value_set_by_key(UserFeedbackDesktop, "comments", sentry_value_new_string(TCHAR_TO_ANSI(*comment)));
}

FString SentryUserFeedbackDesktop::GetComment() const
{
sentry_value_t comment = sentry_value_get_by_key(UserFeedbackDesktop, "comments");
return FString(sentry_value_as_string(comment));
}

#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright (c) 2022 Sentry. All Rights Reserved.

#pragma once

#include "Convenience/SentryInclude.h"

#include "Interface/SentryUserFeedbackInterface.h"

#if USE_SENTRY_NATIVE

class USentryId;

class SentryUserFeedbackDesktop : public ISentryUserFeedback
{
public:
SentryUserFeedbackDesktop();
SentryUserFeedbackDesktop(USentryId* eventId);
virtual ~SentryUserFeedbackDesktop() override;

sentry_value_t GetNativeObject();

virtual void SetName(const FString& name) override;
virtual FString GetName() const override;
virtual void SetEmail(const FString& email) override;
virtual FString GetEmail() const override;
virtual void SetComment(const FString& comment) override;
virtual FString GetComment() const override;

private:
sentry_value_t UserFeedbackDesktop;
};

#endif
4 changes: 4 additions & 0 deletions plugin-dev/Source/Sentry/Private/SentryUserFeedback.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
#include "Android/SentryUserFeedbackAndroid.h"
#elif PLATFORM_IOS || PLATFORM_MAC
#include "Apple/SentryUserFeedbackApple.h"
#elif PLATFORM_WINDOWS || PLATFORM_LINUX
#include "Desktop/SentryUserFeedbackDesktop.h"
#endif

void USentryUserFeedback::Initialize(USentryId* EventId)
Expand All @@ -17,6 +19,8 @@ void USentryUserFeedback::Initialize(USentryId* EventId)
UserFeedbackNativeImpl = MakeShareable(new SentryUserFeedbackAndroid(EventId));
#elif PLATFORM_IOS || PLATFORM_MAC
UserFeedbackNativeImpl = MakeShareable(new SentryUserFeedbackApple(EventId));
#elif PLATFORM_WINDOWS || PLATFORM_LINUX
UserFeedbackNativeImpl = MakeShareable(new SentryUserFeedbackDesktop(EventId));
#endif
}

Expand Down
14 changes: 7 additions & 7 deletions scripts/build-deps.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,14 @@ function buildSentryNative()
{
Push-Location -Path "$modulesDir/sentry-native"

cmake -B "build" -D SENTRY_BACKEND=breakpad -D SENTRY_SDK_NAME=sentry.native.unreal
cmake -B "build" -D SENTRY_BACKEND=crashpad -D SENTRY_SDK_NAME=sentry.native.unreal -D SENTRY_BUILD_SHARED_LIBS=OFF
bitsandfoxes marked this conversation as resolved.
Show resolved Hide resolved
cmake --build "build" --target sentry --config RelWithDebInfo --parallel
cmake --build "build" --target crashpad_handler --config RelWithDebInfo --parallel
cmake --install "build" --prefix "install" --config RelWithDebInfo

Pop-Location

$nativeOutDir = "$outDir/Win64"
$nativeOutDir = "$outDir/Win64/Crashpad"
$nativeOutDirLibs = "$nativeOutDir/lib"
$nativeOutDirBinaries = "$nativeOutDir/bin"
$nativeOutDirIncludes = "$nativeOutDir/include"
Expand All @@ -126,11 +128,9 @@ function buildSentryNative()
New-Item $nativeOutDirBinaries -ItemType Directory > $null
New-Item $nativeOutDirIncludes -ItemType Directory > $null

Copy-Item "$modulesDir/sentry-native/build/RelWithDebInfo/sentry.lib" -Destination "$nativeOutDirLibs/sentry.lib"
Copy-Item "$modulesDir/sentry-native/build/RelWithDebInfo/sentry.dll" -Destination "$nativeOutDirBinaries/sentry.dll"
Copy-Item "$modulesDir/sentry-native/build/RelWithDebInfo/sentry.pdb" -Destination "$nativeOutDirBinaries/sentry.pdb"
Copy-Item "$modulesDir/sentry-native/build/external/RelWithDebInfo/breakpad_client.lib" -Destination "$nativeOutDirLibs/breakpad_client.lib"
Copy-Item "$modulesDir/sentry-native/include/sentry.h" -Destination "$nativeOutDirIncludes/sentry.h"
Get-ChildItem -Path "$modulesDir/sentry-native/install/lib" -Filter "*.lib" -Recurse | Copy-Item -Destination $nativeOutDirLibs
Copy-Item "$modulesDir/sentry-native/install/bin/crashpad_handler.exe" -Destination $nativeOutDirBinaries
Copy-Item "$modulesDir/sentry-native/install/include/sentry.h" -Destination $nativeOutDirIncludes
}

function buildPlatformDependency([string] $platform)
Expand Down
2 changes: 2 additions & 0 deletions scripts/packaging/package-github.snapshot
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ Source/Sentry/Private/Desktop/SentryTransactionDesktop.cpp
Source/Sentry/Private/Desktop/SentryTransactionDesktop.h
Source/Sentry/Private/Desktop/SentryUserDesktop.cpp
Source/Sentry/Private/Desktop/SentryUserDesktop.h
Source/Sentry/Private/Desktop/SentryUserFeedbackDesktop.cpp
Source/Sentry/Private/Desktop/SentryUserFeedbackDesktop.h
Source/Sentry/Private/Desktop/Transport/
Source/Sentry/Private/Desktop/Transport/SentryDsnUrl.cpp
Source/Sentry/Private/Desktop/Transport/SentryDsnUrl.h
Expand Down
2 changes: 2 additions & 0 deletions scripts/packaging/package-marketplace.snapshot
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ Source/Sentry/Private/Desktop/SentryTransactionDesktop.cpp
Source/Sentry/Private/Desktop/SentryTransactionDesktop.h
Source/Sentry/Private/Desktop/SentryUserDesktop.cpp
Source/Sentry/Private/Desktop/SentryUserDesktop.h
Source/Sentry/Private/Desktop/SentryUserFeedbackDesktop.cpp
Source/Sentry/Private/Desktop/SentryUserFeedbackDesktop.h
Source/Sentry/Private/Desktop/Transport/
Source/Sentry/Private/Desktop/Transport/SentryDsnUrl.cpp
Source/Sentry/Private/Desktop/Transport/SentryDsnUrl.h
Expand Down
Loading