feat(scopes): Support scopes on WebAssembly (#836)

* feat(scopes): Add scopes and SentrySDK.with_scope() on WebAssembly

* Remove patching client on scopes (no longer needed)

* Update test.js

* Update javascript_sdk.cpp

* Remove input validation in JavaScriptScope

* Produce DisabledScope on creation failure

* Update CHANGELOG.md

* Update class docs

* Lighter breadcrumb cast

* Skip reason

* Add additional bridge tests

* Comment

* Implement Castable

Author: limbonaut

CHANGELOG.md

@@ -4,9 +4,9 @@
 
 ### Features
 
-- Add current scope support to the GDScript API to enrich the telemetry captured within a specific part of the code ([#834](https://github.com/getsentry/sentry-godot/pull/834), [#835](https://github.com/getsentry/sentry-godot/pull/835))
+- Add current scope support to the GDScript API to enrich the telemetry captured within a specific part of the code ([#834](https://github.com/getsentry/sentry-godot/pull/834), [#835](https://github.com/getsentry/sentry-godot/pull/835), [#836](https://github.com/getsentry/sentry-godot/pull/836))
   - `SentrySDK.with_scope()` runs a callable with a forked scope, `SentrySDK.get_current_scope()` returns the scope active on the calling thread, and the new `SentryScope` class carries tags, contexts, user, level, fingerprint, breadcrumbs, and attributes on top of the data set globally
-  - Only supported on Windows, Linux, and Android for now, with the remaining platforms still capturing telemetry but discarding the scope data and printing a warning
+  - Not supported on macOS and iOS yet, where telemetry is still captured but the scope data is discarded with a warning
 
 ### Dependencies
 

doc_classes/SentrySDK.xml

@@ -77,7 +77,7 @@
 			<description>
 				Returns the current scope on the calling thread. Inside a [method SentrySDK.with_scope] callable, this is the scope forked for that callable. The fork is discarded when the callable returns, and the parent scope it was forked from becomes current again. Outside of any [method SentrySDK.with_scope], the returned scope stays current for the telemetry captured later on that thread.
 				The returned scope belongs to the calling thread. Data written to it enriches only the telemetry captured on that thread, and modifying it from another thread is not supported. See [SentryScope] for details. To enrich telemetry captured on every thread, use the [SentrySDK] methods such as [method SentrySDK.set_tag] instead.
-				[b]Note:[/b] The SDK supports scopes on Windows, Linux, and Android only for now. On the other platforms it still captures telemetry, but discards the data written to the returned scope.
+				[b]Note:[/b] The SDK does not support scopes on macOS and iOS yet. On those platforms it still captures telemetry, but discards the data written to the returned scope.
 			</description>
 		</method>
 		<method name="get_last_event_id" qualifiers="const">
@@ -209,7 +209,7 @@
 				Writes made through [SentrySDK] methods such as [method SentrySDK.set_tag] still apply globally, even when called inside the callable.
 				For more information, see [SentryScope] class.
 				[b]Note:[/b] The fork covers the synchronous part of [param callable] only. If the callable awaits, the fork is discarded at the first [code]await[/code] and a warning is printed.
-				[b]Note:[/b] The SDK supports scopes on Windows, Linux, and Android only for now. On the other platforms it still captures telemetry, but discards the data written to the forked scope and prints a warning.
+				[b]Note:[/b] The SDK does not support scopes on macOS and iOS yet. On those platforms it still captures telemetry, but discards the data written to the forked scope and prints a warning.
 			</description>
 		</method>
 	</methods>

doc_classes/SentryScope.xml

@@ -14,7 +14,7 @@
 		)
 		[/codeblock]
 		[b]Note:[/b] A scope is thread-local. Modify a scope only from the thread that created it. If a scope is modified from another thread, the SDK rejects the call with an error and discards the data. To enrich telemetry captured on another thread, get that thread's current scope with [method SentrySDK.get_current_scope], or use [SentrySDK] methods such as [method SentrySDK.set_tag] to enrich telemetry captured on all threads.
-		[b]Note:[/b] The SDK supports scopes on Windows, Linux, and Android only for now. On the other platforms it still captures telemetry, but discards the data written to the scope.
+		[b]Note:[/b] The SDK does not support scopes on macOS and iOS yet. On those platforms it still captures telemetry, but discards the data written to the scope.
 	</description>
 	<tutorials>
 	</tutorials>

project/test/isolated/test_metrics.gd

@@ -170,6 +170,7 @@ func test_before_send_metric_discard() -> void:
 
 
 # TODO: remove skip when implemented on other platforms
+# Skipped: JS merges scope attributes at serialization time, after the callback has already run.
 func test_metric_with_scope_attributes(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android"]) -> void:
 	SentrySDK.set_attribute("from_global", "global")
 	SentrySDK.set_attribute("scope_over_global", "global")
@@ -205,6 +206,7 @@ func test_metric_with_scope_attributes(_do_skip = OS.get_name() not in ["Windows
 
 
 # TODO: remove skip when implemented on other platforms
+# Skipped: JS merges scope attributes at serialization time, after the callback has already run.
 func test_metric_with_scope_attribute_types(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android"]) -> void:
 	SentrySDK.with_scope(func(scope: SentryScope):
 		scope.set_attribute("level", "forest")

project/test/isolated/test_structured_logs.gd

@@ -199,6 +199,7 @@ func test_structured_logs_with_global_attributes(_do_skip = OS.get_name() == "We
 
 
 # TODO: remove skip when implemented on other platforms
+# Skipped: JS merges scope attributes at serialization time, after the callback has already run.
 func test_structured_logs_with_scope_attributes(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android"]) -> void:
 	SentrySDK.set_attribute("from_global", "global")
 	SentrySDK.set_attribute("scope_over_global", "global")
@@ -234,6 +235,7 @@ func test_structured_logs_with_scope_attributes(_do_skip = OS.get_name() not in
 
 
 # TODO: remove skip when implemented on other platforms
+# Skipped: JS merges scope attributes at serialization time, after the callback has already run.
 func test_structured_logs_with_scope_attribute_types(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android"]) -> void:
 	SentrySDK.with_scope(func(scope: SentryScope):
 		scope.set_attribute("level", "forest")

project/test/suites/test_scope.gd

@@ -3,7 +3,7 @@ extends SentryTestSuite
 
 
 # TODO: widen the platform list as scopes are implemented on other backends.
-func before(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android"],
+func before(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android", "Web"],
 		_skip_reason = "Scopes are not implemented on this platform yet.") -> void:
 	super()
 

project/test/suites/test_trace.gd

@@ -3,7 +3,7 @@ extends SentryTestSuite
 
 
 # TODO: widen the platform list as scopes are implemented on other backends.
-func before(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android"],
+func before(_do_skip = OS.get_name() not in ["Windows", "Linux", "Android", "Web"],
 		_skip_reason = "Scopes are not implemented on this platform yet.") -> void:
 	super()
 

src/sentry/android/android_scope.h

@@ -5,6 +5,8 @@
 namespace sentry::android {
 
 class AndroidScope : public SentryScopeImpl {
+	SENTRY_CASTABLE(AndroidScope, SentryScopeImpl);
+
 private:
 	Object *android_plugin = nullptr;
 	int32_t handle = 0;

src/sentry/castable.h

@@ -0,0 +1,69 @@
+#pragma once
+
+#include <type_traits>
+
+namespace sentry {
+
+// Casts between related classes without the cost of dynamic_cast.
+// Declare with SENTRY_CASTABLE in every participating class, naming Castable
+// as the base in the root class.
+class Castable {
+public:
+	struct TypeInfo {
+		const TypeInfo *parent;
+	};
+
+	static constexpr TypeInfo type_info{ nullptr };
+
+	// Returns true if p_from is a T, or derives from T. Null is safe and never matches.
+	template <typename T>
+	static bool is_class(const Castable *p_from) {
+		static_assert(std::is_same_v<typename T::castable_self, T>,
+				"T must declare SENTRY_CASTABLE");
+		if (!p_from) {
+			return false;
+		}
+		const TypeInfo *t = p_from->get_type_info();
+		while (t) {
+			if (t == &T::type_info) {
+				return true;
+			}
+			t = t->parent;
+		}
+		return false;
+	}
+
+	// Returns p_from as T, or null if it isn't one. Null is safe.
+	template <typename T>
+	static T *cast_to(Castable *p_from) {
+		return is_class<T>(p_from) ? static_cast<T *>(p_from) : nullptr;
+	}
+
+	// Returns p_from as T, or null if it isn't one. Null is safe.
+	template <typename T>
+	static const T *cast_to(const Castable *p_from) {
+		return is_class<T>(p_from) ? static_cast<const T *>(p_from) : nullptr;
+	}
+
+	virtual ~Castable() = default;
+
+protected:
+	virtual const TypeInfo *get_type_info() const = 0;
+};
+
+} //namespace sentry
+
+// Adds type info to a castable class. Add at the top of the class body.
+#define SENTRY_CASTABLE(m_class, m_base)                                           \
+public:                                                                            \
+	using castable_self = m_class;                                                 \
+	static constexpr ::sentry::Castable::TypeInfo type_info{ &m_base::type_info }; \
+                                                                                   \
+protected:                                                                         \
+	virtual const ::sentry::Castable::TypeInfo *get_type_info() const override {   \
+		static_assert(std::is_base_of_v<m_base, m_class>,                          \
+				#m_base " must be a base of " #m_class ".");                       \
+		return &type_info;                                                         \
+	}                                                                              \
+                                                                                   \
+private:

src/sentry/disabled/disabled_scope.h

@@ -5,6 +5,8 @@
 namespace sentry {
 
 class DisabledScope : public SentryScopeImpl {
+	SENTRY_CASTABLE(DisabledScope, SentryScopeImpl);
+
 public:
 	virtual void set_context(const String &p_key, const Dictionary &p_value) override {}
 	virtual void set_tag(const String &p_key, const String &p_value) override {}