Merge branch 'main' into feat/breadcrumb-hook

Author: limbonaut

CHANGELOG.md

@@ -9,6 +9,7 @@
 ### Features
 
 - In-editor class reference documentation ([#104](https://github.com/getsentry/sentry-godot/pull/104))
+- Capture screenshots when enabled via `attach_screenshot` option ([#128](https://github.com/getsentry/sentry-godot/pull/128))
 
 ### Fixes
 

SConstruct

@@ -222,6 +222,7 @@ env.Append(CPPPATH=["src/"])
 # Source files to compile.
 sources = Glob("src/*.cpp")
 sources += Glob("src/sentry/*.cpp")
+sources += Glob("src/sentry/util/*.cpp")
 # Compile sentry-native code only on respective platforms.
 if env["platform"] in ["linux", "windows", "macos"]:
     sources += Glob("src/sentry/native/*.cpp")

doc_classes/SentryConfiguration.xml

@@ -18,7 +18,7 @@
 		    options.before_send = _process_event
 		    options.on_crash = _process_event
 
-		func _process_event(event: SentryEvent) -> SentryEvent:
+		func _process_event(event: SentryEvent) -> SentryEvent:
 		    if event.environment == "debug":
 		        # Discard event if running in a debug build.
 		        return null

doc_classes/SentryOptions.xml

@@ -13,6 +13,9 @@
 		<member name="attach_log" type="bool" setter="set_attach_log" getter="is_attach_log_enabled" default="true">
 			If [code]true[/code], the SDK will attach the Godot log file to the event.
 		</member>
+		<member name="attach_screenshot" type="bool" setter="set_attach_screenshot" getter="is_attach_screenshot_enabled" default="false">
+			If [code]true[/code], the SDK will try to capture and attach a screenshot to the event.
+		</member>
 		<member name="before_send" type="Callable" setter="set_before_send" getter="get_before_send" default="Callable()">
 			If assigned, this callback runs before a message or error event is sent to Sentry. It takes [SentryEvent] as a parameter and return either the same event object, with or without modifications, or [code]null[/code] to skip reporting the event. You can assign it in a [SentryConfiguration] script.
 			[codeblock]

project/project.godot

@@ -37,4 +37,5 @@ ui/toolbar/run_overall=true
 [sentry]
 
 options/dsn="https://[email protected]/6680910"
+options/attach_screenshot=true
 options/configuration_script="res://example_configuration.gd"

src/sentry/native/native_sdk.cpp

@@ -7,13 +7,18 @@
 #include "sentry/native/native_event.h"
 #include "sentry/native/native_util.h"
 #include "sentry/util.h"
+#include "sentry/util/screenshot.h"
 #include "sentry_options.h"
 
 #include <chrono>
+#include <godot_cpp/classes/dir_access.hpp>
+#include <godot_cpp/classes/display_server.hpp>
 #include <godot_cpp/classes/file_access.hpp>
 #include <godot_cpp/classes/os.hpp>
 #include <godot_cpp/classes/project_settings.hpp>
 
+#define _SCREENSHOT_FN "screenshot.png"
+
 namespace {
 
 void sentry_event_set_context(sentry_value_t p_event, const char *p_context_name, const Dictionary &p_context) {
@@ -45,7 +50,21 @@ void sentry_event_set_context(sentry_value_t p_event, const char *p_context_name
 	}
 }
 
-inline void inject_contexts(sentry_value_t p_event) {
+inline void _save_screenshot() {
+	String screenshot_path = "user://" _SCREENSHOT_FN;
+	DirAccess::remove_absolute(screenshot_path);
+
+	if (!DisplayServer::get_singleton() || DisplayServer::get_singleton()->get_name() == "headless") {
+		return;
+	}
+
+	PackedByteArray buffer = sentry::util::take_screenshot();
+	Ref<FileAccess> f = FileAccess::open(screenshot_path, FileAccess::WRITE);
+	f->store_buffer(buffer);
+	f->close();
+}
+
+inline void _inject_contexts(sentry_value_t p_event) {
 	ERR_FAIL_COND(sentry_value_get_type(p_event) != SENTRY_VALUE_TYPE_OBJECT);
 
 	HashMap<String, Dictionary> contexts = sentry::contexts::make_event_contexts();
@@ -66,9 +85,10 @@ void test_performance(sentry_value_t ev) {
 	sentry::util::print_debug(context_dic);
 }
 
-sentry_value_t handle_before_send(sentry_value_t event, void *hint, void *closure) {
+sentry_value_t _handle_before_send(sentry_value_t event, void *hint, void *closure) {
 	sentry::util::print_debug("handling before_send");
-	inject_contexts(event);
+	_save_screenshot();
+	_inject_contexts(event);
 	test_performance(event);
 	if (const Callable &before_send = SentryOptions::get_singleton()->get_before_send(); before_send.is_valid()) {
 		Ref<NativeEvent> event_obj = memnew(NativeEvent(event));
@@ -85,8 +105,10 @@ sentry_value_t handle_before_send(sentry_value_t event, void *hint, void *closur
 	return event;
 }
 
-sentry_value_t handle_on_crash(const sentry_ucontext_t *uctx, sentry_value_t event, void *closure) {
-	inject_contexts(event);
+sentry_value_t _handle_on_crash(const sentry_ucontext_t *uctx, sentry_value_t event, void *closure) {
+	sentry::util::print_debug("handling on_crash");
+	_save_screenshot();
+	_inject_contexts(event);
 	if (const Callable &on_crash = SentryOptions::get_singleton()->get_on_crash(); on_crash.is_valid()) {
 		Ref<NativeEvent> event_obj = memnew(NativeEvent(event));
 		Ref<NativeEvent> processed = on_crash.call(event_obj);
@@ -295,9 +317,15 @@ void NativeSDK::initialize() {
 		}
 	}
 
+	// Attach screenshot.
+	if (SentryOptions::get_singleton()->is_attach_screenshot_enabled()) {
+		String screenshot_path = OS::get_singleton()->get_user_data_dir().path_join(_SCREENSHOT_FN);
+		sentry_options_add_attachment(options, screenshot_path.utf8());
+	}
+
 	// Hooks.
-	sentry_options_set_before_send(options, handle_before_send, NULL);
-	sentry_options_set_on_crash(options, handle_on_crash, NULL);
+	sentry_options_set_before_send(options, _handle_before_send, NULL);
+	sentry_options_set_on_crash(options, _handle_on_crash, NULL);
 
 	int err = sentry_init(options);
 	initialized = (err == 0);

src/sentry/util/screenshot.cpp

@@ -0,0 +1,26 @@
+#include "screenshot.h"
+
+#include <godot_cpp/classes/engine.hpp>
+#include <godot_cpp/classes/rendering_server.hpp>
+#include <godot_cpp/classes/scene_tree.hpp>
+#include <godot_cpp/classes/viewport_texture.hpp>
+#include <godot_cpp/classes/window.hpp>
+
+using namespace godot;
+
+namespace sentry::util {
+
+PackedByteArray take_screenshot() {
+	SceneTree *sml = Object::cast_to<SceneTree>(Engine::get_singleton()->get_main_loop());
+	ERR_FAIL_NULL_V_MSG(sml, PackedByteArray(), "Sentry: Failed to capture screenshot - couldn't get scene tree.");
+
+	Window *main_window = sml->get_root();
+	ERR_FAIL_NULL_V_MSG(main_window, PackedByteArray(), "Sentry: Failed to capture screenshot - couldn't get main window.");
+
+	Ref<ViewportTexture> tex = main_window->get_texture();
+	Ref<Image> img = tex->get_image();
+	PackedByteArray bytes = img->save_png_to_buffer();
+	return bytes;
+}
+
+} //namespace sentry::util

src/sentry/util/screenshot.h

@@ -0,0 +1,16 @@
+#ifndef SCREENSHOT_H
+#define SCREENSHOT_H
+
+namespace godot {
+
+class PackedByteArray;
+
+}
+
+namespace sentry::util {
+
+godot::PackedByteArray take_screenshot();
+
+}
+
+#endif // SCREENSHOT_H

src/sentry_options.cpp

@@ -57,10 +57,12 @@ void SentryOptions::_define_project_settings(const Ref<SentryOptions> &p_options
 	_define_setting("sentry/options/dist", p_options->dist);
 	_define_setting(PropertyInfo(Variant::INT, "sentry/options/debug_printing", PROPERTY_HINT_ENUM, "Off,On,Auto"), (int)SentryOptions::DEBUG_DEFAULT);
 	_define_setting(PropertyInfo(Variant::FLOAT, "sentry/options/sample_rate", PROPERTY_HINT_RANGE, "0.0,1.0"), p_options->sample_rate);
-	_define_setting("sentry/options/attach_log", p_options->attach_log);
 	_define_setting(PropertyInfo(Variant::INT, "sentry/options/max_breadcrumbs", PROPERTY_HINT_RANGE, "0, 500"), p_options->max_breadcrumbs);
 	_define_setting("sentry/options/send_default_pii", p_options->send_default_pii);
 
+	_define_setting("sentry/options/attach_log", p_options->attach_log);
+	_define_setting("sentry/options/attach_screenshot", p_options->attach_screenshot);
+
 	_define_setting("sentry/options/error_logger/enabled", p_options->error_logger_enabled);
 	_define_setting("sentry/options/error_logger/include_source", p_options->error_logger_include_source);
 	_define_setting(PropertyInfo(Variant::INT, "sentry/options/error_logger/events", PROPERTY_HINT_FLAGS, sentry::GODOT_ERROR_MASK_EXPORT_STRING()), p_options->error_logger_event_mask);
@@ -98,10 +100,12 @@ void SentryOptions::_load_project_settings(const Ref<SentryOptions> &p_options)
 	p_options->_init_debug_option(mode);
 
 	p_options->sample_rate = ProjectSettings::get_singleton()->get_setting("sentry/options/sample_rate", p_options->sample_rate);
-	p_options->attach_log = ProjectSettings::get_singleton()->get_setting("sentry/options/attach_log", p_options->attach_log);
 	p_options->max_breadcrumbs = ProjectSettings::get_singleton()->get_setting("sentry/options/max_breadcrumbs", p_options->max_breadcrumbs);
 	p_options->send_default_pii = ProjectSettings::get_singleton()->get_setting("sentry/options/send_default_pii", p_options->send_default_pii);
 
+	p_options->attach_log = ProjectSettings::get_singleton()->get_setting("sentry/options/attach_log", p_options->attach_log);
+	p_options->attach_screenshot = ProjectSettings::get_singleton()->get_setting("sentry/options/attach_screenshot", p_options->attach_screenshot);
+
 	p_options->error_logger_enabled = ProjectSettings::get_singleton()->get_setting("sentry/options/error_logger/enabled", p_options->error_logger_enabled);
 	p_options->error_logger_include_source = ProjectSettings::get_singleton()->get_setting("sentry/options/error_logger/include_source", p_options->error_logger_include_source);
 	p_options->error_logger_event_mask = (int)ProjectSettings::get_singleton()->get_setting("sentry/options/error_logger/events", p_options->error_logger_event_mask);
@@ -154,10 +158,12 @@ void SentryOptions::_bind_methods() {
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "debug"), set_debug_enabled, is_debug_enabled);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::STRING, "environment"), set_environment, get_environment);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::FLOAT, "sample_rate"), set_sample_rate, get_sample_rate);
-	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "attach_log"), set_attach_log, is_attach_log_enabled);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::INT, "max_breadcrumbs"), set_max_breadcrumbs, get_max_breadcrumbs);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "send_default_pii"), set_send_default_pii, is_send_default_pii_enabled);
 
+	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "attach_log"), set_attach_log, is_attach_log_enabled);
+	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "attach_screenshot"), set_attach_screenshot, is_attach_screenshot_enabled);
+
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "error_logger_enabled"), set_error_logger_enabled, is_error_logger_enabled);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::BOOL, "error_logger_include_source"), set_error_logger_include_source, is_error_logger_include_source_enabled);
 	BIND_PROPERTY(SentryOptions, PropertyInfo(Variant::INT, "error_logger_event_mask"), set_error_logger_event_mask, get_error_logger_event_mask);

src/sentry_options.h

@@ -55,10 +55,12 @@ class SentryOptions : public RefCounted {
 	bool debug = false;
 	String environment;
 	double sample_rate = 1.0;
-	bool attach_log = true;
 	int max_breadcrumbs = 100;
 	bool send_default_pii = false;
 
+	bool attach_log = true;
+	bool attach_screenshot = false;
+
 	bool error_logger_enabled = true;
 	bool error_logger_include_source = true;
 	BitField<GodotErrorMask> error_logger_event_mask = int(GodotErrorMask::MASK_ALL_EXCEPT_WARNING);
@@ -107,15 +109,18 @@ class SentryOptions : public RefCounted {
 	_FORCE_INLINE_ double get_sample_rate() const { return sample_rate; }
 	_FORCE_INLINE_ void set_sample_rate(double p_sample_rate) { sample_rate = p_sample_rate; }
 
-	_FORCE_INLINE_ bool is_attach_log_enabled() const { return attach_log; }
-	_FORCE_INLINE_ void set_attach_log(bool p_enabled) { attach_log = p_enabled; }
-
 	_FORCE_INLINE_ int get_max_breadcrumbs() const { return max_breadcrumbs; }
 	_FORCE_INLINE_ void set_max_breadcrumbs(int p_max_breadcrumbs) { max_breadcrumbs = p_max_breadcrumbs; }
 
 	_FORCE_INLINE_ bool is_send_default_pii_enabled() const { return send_default_pii; }
 	_FORCE_INLINE_ void set_send_default_pii(bool p_enabled) { send_default_pii = p_enabled; }
 
+	_FORCE_INLINE_ bool is_attach_log_enabled() const { return attach_log; }
+	_FORCE_INLINE_ void set_attach_log(bool p_enabled) { attach_log = p_enabled; }
+
+	_FORCE_INLINE_ bool is_attach_screenshot_enabled() const { return attach_screenshot; }
+	_FORCE_INLINE_ void set_attach_screenshot(bool p_attach_screenshot) { attach_screenshot = p_attach_screenshot; }
+
 	_FORCE_INLINE_ bool is_error_logger_enabled() const { return error_logger_enabled; }
 	_FORCE_INLINE_ void set_error_logger_enabled(bool p_enabled) { error_logger_enabled = p_enabled; }