Skip to content

fix: UTF-8 retention problems with native SentryEvent properties #345

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 3, 2025
Merged

fix: UTF-8 retention problems with native SentryEvent properties #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
700d765
Add UTF-8 tests
limbonaut Sep 2, 2025
b6becd1
Fix UTF-8 issues in native SentryEvent implementation
limbonaut Sep 2, 2025
d4522d9
Update CHANGELOG.md
limbonaut Sep 3, 2025
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

- Potential crash in SentryLogger if removed early ([#323](https://github.com/getsentry/sentry-godot/pull/323))
- Ensure compatibility with minSdk 24 on Android ([#324](https://github.com/getsentry/sentry-godot/pull/324))
- Fixed UTF-8 retention problems with native SentryEvent properties ([#345](https://github.com/getsentry/sentry-godot/pull/345))

## Other changes

Expand Down
60 changes: 19 additions & 41 deletions project/test/suites/test_event.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,26 @@ extends GdUnitTestSuite
## Basic tests for the SentryEvent class.


## SentryEvent.id should not be empty on event creation.
func test_event_id() -> void:
## Test string properties accessors and UTF-8 encoding preservation.
@warning_ignore("unused_parameter")
func test_string_properties_and_utf8(property: String, test_parameters := [
["message"],
["logger"],
["release"],
["dist"],
["environment"],
]) -> void:
var event := SentrySDK.create_event()
assert_str(event.id).is_not_empty()
event.set(property, "Hello, World!")
assert_str(event.get(property)).is_equal("Hello, World!")
event.set(property, "Hello 世界! 👋")
assert_str(event.get(property)).is_equal("Hello 世界! 👋")

Copy link
Collaborator Author

@limbonaut limbonaut Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This replaces multiple tests removed below.


## SentryEvent.message should be set to the specified value, and should be empty on event creation.
func test_event_message() -> void:
## SentryEvent.id should not be empty on event creation.
func test_event_id_not_empty() -> void:
var event := SentrySDK.create_event()
assert_str(event.message).is_empty()
event.message = "Hello, World!"
assert_str(event.message).is_equal("Hello, World!")
assert_str(event.id).is_not_empty()


## SentryEvent.level should be set to the specified value.
Expand Down Expand Up @@ -51,43 +59,11 @@ func test_event_timestamp() -> void:


## SentryEvent.platform should not be empty.
func test_event_platform() -> void:
func test_event_platform_not_empty() -> void:
var event := SentrySDK.create_event()
assert_str(event.platform).is_not_empty()


## SentryEvent.logger should be set to the specified value, and empty on event creation.
func test_event_logger() -> void:
var event := SentrySDK.create_event()
assert_str(event.logger).is_empty()
event.logger = "custom-logger"
assert_str(event.logger).is_equal("custom-logger")


## SentryEvent.release should be set to the specified value, and empty on event creation.
func test_event_release() -> void:
var event := SentrySDK.create_event()
assert_str(event.release).is_empty()
event.release = "custom-release"
assert_str(event.release).is_equal("custom-release")


## SentryEvent.dist should be set to the specified value, and empty on event creation.
func test_event_dist() -> void:
var event := SentrySDK.create_event()
assert_str(event.dist).is_empty()
event.dist = "custom-dist"
assert_str(event.dist).is_equal("custom-dist")


## SentryEvent.environment should be set to the specified value, and empty on event creation.
func test_event_environment() -> void:
var event := SentrySDK.create_event()
assert_str(event.environment).is_empty()
event.environment = "custom-environment"
assert_str(event.environment).is_equal("custom-environment")


## SentryEvent.set_tag() should set tag to the specified value, remove_tag() should unset it.
func test_event_tags() -> void:
var event := SentrySDK.create_event()
Expand All @@ -96,6 +72,8 @@ func test_event_tags() -> void:
assert_str(event.get_tag("test_tag")).is_equal("test_value")
event.remove_tag("test_tag")
assert_str(event.get_tag("test_tag")).is_empty()
event.set_tag("test_utf8", "Hello 世界! 👋")
assert_str(event.get_tag("test_utf8")).is_equal("Hello 世界! 👋")


## SentryEvent.is_crash() should return false on a custom-created event.
Expand Down
4 changes: 3 additions & 1 deletion project/test/suites/test_sdk.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ signal callback_processed


## SentrySDK.capture_message() should return a non-empty event ID, which must match the ID returned by the get_last_event_id() call.
func test_capture_message() -> void:
func test_capture_message_id() -> void:
var event_id := SentrySDK.capture_message("capture_message_test", SentrySDK.LEVEL_DEBUG)
assert_str(event_id).is_not_empty()
assert_str(SentrySDK.get_last_event_id()).is_not_empty()
Expand All @@ -18,10 +18,12 @@ func test_set_tag() -> void:
SentrySDK._set_before_send(
func(ev: SentryEvent):
assert_str(ev.get_tag("custom-tag")).is_equal("custom-tag-value")
assert_str(ev.get_tag("utf8-test")).is_equal("Hello 世界! 👋")
callback_processed.emit()
return null)

SentrySDK.set_tag("custom-tag", "custom-tag-value")
SentrySDK.set_tag("utf8-test", "Hello 世界! 👋")

var monitor := monitor_signals(self, false)
SentrySDK.capture_message("test-tags")
Expand Down
14 changes: 7 additions & 7 deletions src/sentry/native/native_event.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ String NativeEvent::get_message() const {
return String();
}
sentry_value_t formatted = sentry_value_get_by_key(message, "formatted");
return sentry_value_as_string(formatted);
return String::utf8(sentry_value_as_string(formatted));
}

void NativeEvent::set_timestamp(const Ref<SentryTimestamp> &p_timestamp) {
Expand All @@ -91,7 +91,7 @@ Ref<SentryTimestamp> NativeEvent::get_timestamp() const {

String NativeEvent::get_platform() const {
sentry_value_t platform = sentry_value_get_by_key(native_event, "platform");
return sentry_value_as_string(platform);
return String::utf8(sentry_value_as_string(platform));
}

void NativeEvent::set_level(sentry::Level p_level) {
Expand All @@ -116,7 +116,7 @@ void NativeEvent::set_logger(const String &p_logger) {

String NativeEvent::get_logger() const {
sentry_value_t logger = sentry_value_get_by_key(native_event, "logger");
return sentry_value_as_string(logger);
return String::utf8(sentry_value_as_string(logger));
}

void NativeEvent::set_release(const String &p_release) {
Expand All @@ -125,7 +125,7 @@ void NativeEvent::set_release(const String &p_release) {

String NativeEvent::get_release() const {
sentry_value_t release = sentry_value_get_by_key(native_event, "release");
return sentry_value_as_string(release);
return String::utf8(sentry_value_as_string(release));
}

void NativeEvent::set_dist(const String &p_dist) {
Expand All @@ -134,7 +134,7 @@ void NativeEvent::set_dist(const String &p_dist) {

String NativeEvent::get_dist() const {
sentry_value_t dist = sentry_value_get_by_key(native_event, "dist");
return sentry_value_as_string(dist);
return String::utf8(sentry_value_as_string(dist));
}

void NativeEvent::set_environment(const String &p_environment) {
Expand All @@ -143,7 +143,7 @@ void NativeEvent::set_environment(const String &p_environment) {

String NativeEvent::get_environment() const {
sentry_value_t environment = sentry_value_get_by_key(native_event, "environment");
return sentry_value_as_string(environment);
return String::utf8(sentry_value_as_string(environment));
}

void NativeEvent::set_tag(const String &p_key, const String &p_value) {
Expand All @@ -169,7 +169,7 @@ String NativeEvent::get_tag(const String &p_key) {
sentry_value_t tags = sentry_value_get_by_key(native_event, "tags");
if (!sentry_value_is_null(tags)) {
sentry_value_t value = sentry_value_get_by_key(tags, p_key.utf8());
return String(sentry_value_as_string(value));
return String::utf8(sentry_value_as_string(value));
}
return String();
}
Expand Down
Loading