Add native local scope for Windows/Linux (#928)

* Set local scope branch for sentry-native submodule

* Update changelog

* Bump submodule

* Bump submodule again

* Add local scope implementation for desktop

* Fix lint errors

* Fix

* Include order

* Revert scope data caching on Unreal's side

* Fix lint errors

* Remove env and dist setters from scope class

* Update changelog

* Remove ConfigureScope function

* Update changelog

* Remove redundant array size checks

* Free memory after capturing event with local scope

* Bump submodule

* Remove sentry_scope_free calls as this API was deleted in native

* Fix blueprint errors

* Update CHANGELOG.md

Author: tustanivsky

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+- `Environment` and `Dist` get/set functions were removed from the `Scope` class and now these properties have to be set in plugin settings instead. This unifies their usage across all platforms supported by the Unreal SDK.
+- `ConfigureScope` function was removed from `SentrySubsystem` class following the [Hub & Scope refactoring guidelines](https://develop.sentry.dev/sdk/miscellaneous/hub_and_scope_refactoring/) which recommend deprecating this API.
+
+### Features
+
+- Add native local scope for Windows/Linux ([#928](https://github.com/getsentry/sentry-unreal/pull/928))
+
 ### Dependencies
 
 - Bump Java SDK (Android) from v8.13.1 to v8.13.2 ([#932](https://github.com/getsentry/sentry-unreal/pull/932))

modules/sentry-native

@@ -99,26 +99,6 @@ TMap<FString, FString> FAndroidSentryScope::GetTags() const
 	return FAndroidSentryConverters::StringMapToUnreal(*tags);
 }
 
-void FAndroidSentryScope::SetDist(const FString& dist)
-{
-	SetTagValue("dist", dist);
-}
-
-FString FAndroidSentryScope::GetDist() const
-{
-	return GetTagValue("dist");
-}
-
-void FAndroidSentryScope::SetEnvironment(const FString& environment)
-{
-	SetTagValue("environment", environment);
-}
-
-FString FAndroidSentryScope::GetEnvironment() const
-{
-	return GetTagValue("environment");
-}
-
 void FAndroidSentryScope::SetFingerprint(const TArray<FString>& fingerprint)
 {
 	CallMethod<void>(SetFingerprintMethod, FAndroidSentryConverters::StringArrayToNative(fingerprint)->GetJObject());

plugin-dev/Source/Sentry/Private/Android/AndroidSentryScope.cpp

@@ -23,10 +23,6 @@ class FAndroidSentryScope : public ISentryScope, public FSentryJavaObjectWrapper
 	virtual void RemoveTag(const FString& key) override;
 	virtual void SetTags(const TMap<FString, FString>& tags) override;
 	virtual TMap<FString, FString> GetTags() const override;
-	virtual void SetDist(const FString& dist) override;
-	virtual FString GetDist() const override;
-	virtual void SetEnvironment(const FString& environment) override;
-	virtual FString GetEnvironment() const override;
 	virtual void SetFingerprint(const TArray<FString>& fingerprint) override;
 	virtual TArray<FString> GetFingerprint() const override;
 	virtual void SetLevel(ESentryLevel level) override;

plugin-dev/Source/Sentry/Private/Android/AndroidSentryScope.h

@@ -33,6 +33,7 @@ void FAndroidSentrySubsystem::InitWithSettings(const USentrySettings* settings,
 	SettingsJson->SetStringField(TEXT("dsn"), settings->Dsn);
 	SettingsJson->SetStringField(TEXT("release"), settings->OverrideReleaseName ? settings->Release : settings->GetFormattedReleaseName());
 	SettingsJson->SetStringField(TEXT("environment"), settings->Environment);
+	SettingsJson->SetStringField(TEXT("dist"), settings->Dist);
 	SettingsJson->SetBoolField(TEXT("autoSessionTracking"), settings->EnableAutoSessionTracking);
 	SettingsJson->SetNumberField(TEXT("sessionTimeout"), settings->SessionTimeout);
 	SettingsJson->SetBoolField(TEXT("enableStackTrace"), settings->AttachStacktrace);
@@ -195,13 +196,6 @@ void FAndroidSentrySubsystem::RemoveUser()
 	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::Sentry, "setUser", "(Lio/sentry/protocol/User;)V", nullptr);
 }
 
-void FAndroidSentrySubsystem::ConfigureScope(const FSentryScopeDelegate& onConfigureScope)
-{
-	int64 scopeCallbackId = AndroidSentryScopeCallback::SaveDelegate(onConfigureScope);
-
-	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "configureScope", "(J)V", scopeCallbackId);
-}
-
 void FAndroidSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)
 {
 	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "setContext", "(Ljava/lang/String;Ljava/util/HashMap;)V",

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.cpp

@@ -22,7 +22,6 @@ class FAndroidSentrySubsystem : public ISentrySubsystem
 	virtual void CaptureUserFeedback(TSharedPtr<ISentryUserFeedback> userFeedback) override;
 	virtual void SetUser(TSharedPtr<ISentryUser> user) override;
 	virtual void RemoveUser() override;
-	virtual void ConfigureScope(const FSentryScopeDelegate& onConfigureScope) override;
 	virtual void SetContext(const FString& key, const TMap<FString, FString>& values) override;
 	virtual void SetTag(const FString& key, const FString& value) override;
 	virtual void RemoveTag(const FString& key) override;

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.h

@@ -46,6 +46,7 @@ public void configure(SentryAndroidOptions options) {
 					options.setDsn(settingJson.getString("dsn"));
 					options.setRelease(settingJson.getString("release"));
 					options.setEnvironment(settingJson.getString("environment"));
+					options.setDist(settingJson.getString("dist"));
 					options.setEnableAutoSessionTracking(settingJson.getBoolean("autoSessionTracking"));
 					options.setSessionTrackingIntervalMillis(settingJson.getLong("sessionTimeout"));
 					options.setAttachStacktrace(settingJson.getBoolean("enableStackTrace"));
@@ -146,15 +147,6 @@ public static SentryId captureException(final String type, final String value) {
 		return eventId;
 	}
 
-	public static void configureScope(final long callback) {
-		Sentry.configureScope(new ScopeCallback() {
-			@Override
-			public void run(@NonNull IScope scope) {
-				onConfigureScope(callback, scope);
-			}
-		});
-	}
-
 	public static void setContext(final String key, final HashMap<String, String> values) {
 		Sentry.configureScope(new ScopeCallback() {
 			@Override

plugin-dev/Source/Sentry/Private/Android/Java/SentryBridgeJava.java

@@ -81,28 +81,6 @@ TMap<FString, FString> FAppleSentryScope::GetTags() const
 	return FAppleSentryConverters::StringMapToUnreal(scopeDict[@"tags"]);
 }
 
-void FAppleSentryScope::SetDist(const FString& dist)
-{
-	[ScopeApple setDist:dist.GetNSString()];
-}
-
-FString FAppleSentryScope::GetDist() const
-{
-	NSDictionary* scopeDict = [ScopeApple serialize];
-	return FString(scopeDict[@"dist"]);
-}
-
-void FAppleSentryScope::SetEnvironment(const FString& environment)
-{
-	[ScopeApple setEnvironment:environment.GetNSString()];
-}
-
-FString FAppleSentryScope::GetEnvironment() const
-{
-	NSDictionary* scopeDict = [ScopeApple serialize];
-	return FString(scopeDict[@"environment"]);
-}
-
 void FAppleSentryScope::SetFingerprint(const TArray<FString>& fingerprint)
 {
 	[ScopeApple setFingerprint:FAppleSentryConverters::StringArrayToNative(fingerprint)];

plugin-dev/Source/Sentry/Private/Apple/AppleSentryScope.cpp

@@ -24,10 +24,6 @@ class FAppleSentryScope : public ISentryScope
 	virtual void RemoveTag(const FString& key) override;
 	virtual void SetTags(const TMap<FString, FString>& tags) override;
 	virtual TMap<FString, FString> GetTags() const override;
-	virtual void SetDist(const FString& dist) override;
-	virtual FString GetDist() const override;
-	virtual void SetEnvironment(const FString& environment) override;
-	virtual FString GetEnvironment() const override;
 	virtual void SetFingerprint(const TArray<FString>& fingerprint) override;
 	virtual TArray<FString> GetFingerprint() const override;
 	virtual void SetLevel(ESentryLevel level) override;

plugin-dev/Source/Sentry/Private/Apple/AppleSentryScope.h

@@ -56,6 +56,7 @@ void FAppleSentrySubsystem::InitWithSettings(const USentrySettings* settings, US
 			}
 #endif
 			options.environment = settings->Environment.GetNSString();
+			options.dist = settings->Dist.GetNSString();
 			options.enableAutoSessionTracking = settings->EnableAutoSessionTracking;
 			options.sessionTrackingIntervalMillis = settings->SessionTimeout;
 			options.releaseName = settings->OverrideReleaseName ? settings->Release.GetNSString() : settings->GetFormattedReleaseName().GetNSString();
@@ -288,13 +289,6 @@ void FAppleSentrySubsystem::RemoveUser()
 	[SentrySDK setUser:nil];
 }
 
-void FAppleSentrySubsystem::ConfigureScope(const FSentryScopeDelegate& onConfigureScope)
-{
-	[SentrySDK configureScope:^(SentryScope* scope) {
-		onConfigureScope.ExecuteIfBound(MakeShareable(new FAppleSentryScope(scope)));
-	}];
-}
-
 void FAppleSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)
 {
 	[SentrySDK configureScope:^(SentryScope* scope) {