Add editor menu for automatic CRC configuration (#152)

tustanivsky · web-flow · commit 7eaff60aad9d · 2022-11-23T14:15:55.000+01:00
* Add editor for automatic CRC configuration

* Update changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Features
 
 - Add debug symbols upload settings ([#94](https://github.com/getsentry/sentry-unreal/pull/94))
+- Add editor menu for automatic CRC configuration ([#152](https://github.com/getsentry/sentry-unreal/pull/152))
 
 ### Fixes
 
diff --git a/plugin-dev/Source/Sentry/Private/SentrySettings.cpp b/plugin-dev/Source/Sentry/Private/SentrySettings.cpp
@@ -13,6 +13,7 @@ USentrySettings::USentrySettings(const FObjectInitializer& ObjectInitializer)
 {
 	DsnUrl = TEXT("");
 	Release = TEXT("");
+	CrashReporterUrl = TEXT("");
 
 	LoadDebugSymbolsProperties();
 }
diff --git a/plugin-dev/Source/Sentry/Public/SentrySettings.h b/plugin-dev/Source/Sentry/Public/SentrySettings.h
@@ -78,6 +78,10 @@ class SENTRY_API USentrySettings : public UObject
 		Meta = (DisplayName = "Authentication token", ToolTip = "Authentication token for performing actions against Sentry API.", EditCondition = "UploadSymbolsAutomatically"))
 	FString AuthToken;
 
+	UPROPERTY(Config, EditAnywhere, Category = "Crash Reporter",
+		Meta = (DisplayName = "Crash Reporter Endpoint", ToolTip = "Endpoint that Unreal Engine Crah Reporter should use in order to upload crash data to Sentry."))
+	FString CrashReporterUrl;
+
 private:
 	void LoadDebugSymbolsProperties();
 };
diff --git a/plugin-dev/Source/SentryEditor/Private/SentryEditorModule.cpp b/plugin-dev/Source/SentryEditor/Private/SentryEditorModule.cpp
@@ -9,6 +9,8 @@
 
 #define LOCTEXT_NAMESPACE "FSentryEditorModule"
 
+const FName FSentryEditorModule::ModuleName = "SentryEditor";
+
 void FSentryEditorModule::StartupModule()
 {
 	// This code will execute after your module is loaded into memory; the exact timing is specified in the .uplugin file per-module
@@ -24,6 +26,11 @@ void FSentryEditorModule::ShutdownModule()
 	// we call this function before unloading the module.
 }
 
+FSentryEditorModule& FSentryEditorModule::Get()
+{
+	return FModuleManager::LoadModuleChecked<FSentryEditorModule>(ModuleName);
+}
+
 #undef LOCTEXT_NAMESPACE
 
 IMPLEMENT_MODULE(FSentryEditorModule, SentryEditor)
diff --git a/plugin-dev/Source/SentryEditor/Private/SentrySettingsCustomization.cpp b/plugin-dev/Source/SentryEditor/Private/SentrySettingsCustomization.cpp
@@ -20,6 +20,10 @@
 #include "EditorStyleSet.h"
 #endif
 
+const FString FSentrySettingsCustomization::DefaultCrcEndpoint = TEXT("https://datarouter.ol.epicgames.com/datarouter/api/v1/public/data");
+
+void OnDocumentationLinkClicked(const FSlateHyperlinkRun::FMetadata& Metadata);
+
 TSharedRef<IDetailCustomization> FSentrySettingsCustomization::MakeInstance()
 {
 	return MakeShareable(new FSentrySettingsCustomization);
@@ -35,6 +39,9 @@ void FSentrySettingsCustomization::CustomizeDetails(IDetailLayoutBuilder& Detail
 void FSentrySettingsCustomization::DrawDebugSymbolsNotice(IDetailLayoutBuilder& DetailBuilder)
 {
 	IDetailCategoryBuilder& DebugSymbolsCategory = DetailBuilder.EditCategory(TEXT("Debug Symbols"));
+	IDetailCategoryBuilder& CrashReporterCategory = DetailBuilder.EditCategory(TEXT("Crash Reporter"));
+
+	TSharedPtr<IPropertyHandle> CrashReporterUrlHandle = DetailBuilder.GetProperty(GET_MEMBER_NAME_CHECKED(USentrySettings, CrashReporterUrl));
 
 #if ENGINE_MAJOR_VERSION >= 5
 	const ISlateStyle& Style = FAppStyle::Get();
@@ -50,17 +57,97 @@ void FSentrySettingsCustomization::DrawDebugSymbolsNotice(IDetailLayoutBuilder&
 			[
 				SNew(SHorizontalBox)
 				+ SHorizontalBox::Slot()
-				  .Padding(FMargin(10, 10, 10, 10))
-				  .FillWidth(1.0f)
+				.Padding(FMargin(10, 10, 10, 10))
+				.FillWidth(1.0f)
 				[
 					SNew(SRichTextBlock)
-						.Text(FText::FromString(TEXT("Note that the Sentry SDK creates a <RichTextBlock.TextHighlight>sentry.properties</> file at project root to store the configuration, that should <RichTextBlock.TextHighlight>NOT</> be made publicly available.")))
+						.Text(FText::FromString(TEXT("Note that the Sentry SDK creates a <RichTextBlock.TextHighlight>sentry.properties</> file at project root to store the configuration, "
+							"that should <RichTextBlock.TextHighlight>NOT</> be made publicly available.")))
 						.TextStyle(Style, "MessageLog")
 						.DecoratorStyleSet(&Style)
 						.AutoWrapText(true)
 				]
 			]
 		];
+
+	CrashReporterCategory.AddCustomRow(FText::FromString(TEXT("CrashReporter")), false)
+		.WholeRowWidget
+		[
+			SNew(SVerticalBox)
+			+ SVerticalBox::Slot()
+			.Padding(1)
+			.AutoHeight()
+			[
+				SNew(SBorder)
+				.Padding(1)
+				[
+					SNew(SHorizontalBox)
+					+ SHorizontalBox::Slot()
+					.Padding(FMargin(10, 10, 10, 10))
+					.FillWidth(1.0f)
+					[
+						SNew(SRichTextBlock)
+							.Text(FText::FromString(TEXT("In order to configure Crash Reporter use Sentry's Unreal Engine Endpoint from the Client Keys settings page. "
+								"This will include which project within Sentry you want to see the crashes arriving in real time. "
+								"Note that it's accomplished by modifying the `CrashReportClient` section in the global <RichTextBlock.TextHighlight>DefaultEngine.ini</> file. "
+								"Changing the engine is necessary for this to work!")))
+							.TextStyle(Style, "MessageLog")
+							.DecoratorStyleSet(&Style)
+							.AutoWrapText(true)
+					]
+				]
+			]
+			+ SVerticalBox::Slot()
+			.Padding(FMargin(0, 10, 0, 10))
+			.VAlign(VAlign_Top)
+			[
+				SNew(SRichTextBlock)
+				.Text(FText::FromString(TEXT("<a id=\"browser\" href=\"https://docs.sentry.io/platforms/unreal/setup-crashreporter/\">View the Crash Reporter setup documentation -></>")))
+				.AutoWrapText(true)
+				.DecoratorStyleSet(&FCoreStyle::Get())
+				+ SRichTextBlock::HyperlinkDecorator(TEXT("browser"), FSlateHyperlinkRun::FOnClick::CreateStatic(&OnDocumentationLinkClicked))
+			]
+			+ SVerticalBox::Slot()
+			.Padding(FMargin(0, 10, 0, 10))
+			.AutoHeight()
+			[
+				SNew(SHorizontalBox)
+				+ SHorizontalBox::Slot()
+				.AutoWidth()
+				.Padding(FMargin(0, 0, 5, 0))
+				[
+					SNew(SButton)
+					.HAlign(HAlign_Center)
+					.VAlign(VAlign_Center)
+					.ContentPadding(FMargin(8, 2))
+					.OnClicked_Lambda([=]() -> FReply
+					{
+						FString CrcEndpoint;
+						CrashReporterUrlHandle->GetValue(CrcEndpoint);
+						UpdateCrcConfig(CrcEndpoint);
+						return FReply::Handled();
+					})
+					.Text(FText::FromString(TEXT("Update global settings")))
+					.ToolTipText(FText::FromString(TEXT("Update global crash reporter settings in DefaultEngine.ini configuration file.")))
+				]
+				+ SHorizontalBox::Slot()
+				.AutoWidth()
+				.Padding(FMargin(5, 0, 5, 0))
+				[
+					SNew(SButton)
+					.HAlign(HAlign_Center)
+					.VAlign(VAlign_Center)
+					.ContentPadding(FMargin(8, 2))
+					.OnClicked_Lambda([=]() -> FReply
+					{
+						UpdateCrcConfig(DefaultCrcEndpoint);
+						return FReply::Handled();
+					})
+					.Text(FText::FromString("Reset"))
+					.ToolTipText(FText::FromString(TEXT("Reset crash reporter settings to defaults.")))
+				]
+			]
+		];
 }
 
 void FSentrySettingsCustomization::SetPropertiesUpdateHandler(IDetailLayoutBuilder& DetailBuilder)
@@ -116,3 +203,42 @@ void FSentrySettingsCustomization::UpdatePropertiesFile(const FString& PropertyN
 	PropertiesFile.SetString(TEXT("Sentry"), *PropertyName, *PropertyValue);
 	PropertiesFile.Write(PropertiesFilePath);
 }
+
+void FSentrySettingsCustomization::UpdateCrcConfig(const FString& Url)
+{
+	if (Url.IsEmpty())
+	{
+		return;
+	}
+
+	const FString CrcConfigFilePath = GetCrcConfigPath();
+
+	if (!FPaths::FileExists(CrcConfigFilePath))
+	{
+		return;
+	}
+
+	FConfigCacheIni CrcConfigFile(EConfigCacheType::DiskBacked);
+	CrcConfigFile.LoadFile(CrcConfigFilePath);
+
+	const FString CrcSectionName = FString(TEXT("CrashReportClient"));
+
+	const FString DataRouterUrlKey = FString(TEXT("DataRouterUrl"));
+	const FString DataRouterUrlValue = Url;
+
+	CrcConfigFile.SetString(*CrcSectionName, *DataRouterUrlKey, *DataRouterUrlValue, CrcConfigFilePath);
+}
+
+FString FSentrySettingsCustomization::GetCrcConfigPath()
+{
+	return FPaths::Combine(FPaths::EngineDir(), TEXT("Programs"), TEXT("CrashReportClient"), TEXT("Config"), TEXT("DefaultEngine.ini"));
+}
+
+void OnDocumentationLinkClicked(const FSlateHyperlinkRun::FMetadata& Metadata)
+{
+	const FString* UrlPtr = Metadata.Find(TEXT("href"));
+	if (UrlPtr)
+	{
+		FPlatformProcess::LaunchURL(**UrlPtr, nullptr, nullptr);
+	}
+}
diff --git a/plugin-dev/Source/SentryEditor/Public/SentryEditorModule.h b/plugin-dev/Source/SentryEditor/Public/SentryEditorModule.h
@@ -11,4 +11,14 @@ class FSentryEditorModule : public IModuleInterface
 	/** IModuleInterface implementation */
 	virtual void StartupModule() override;
 	virtual void ShutdownModule() override;
+
+	/**
+	 * Singleton-like access to this module's interface. This is just for convenience!
+	 * Beware of calling this during the shutdown phase, though. Your module might be already unloaded.
+	 *
+	 * @return Returns singleton instance, loading the module on demand if needed.
+	 */
+	static FSentryEditorModule& Get();
+
+	static const FName ModuleName;
 };
diff --git a/plugin-dev/Source/SentryEditor/Public/SentrySettingsCustomization.h b/plugin-dev/Source/SentryEditor/Public/SentrySettingsCustomization.h
@@ -5,6 +5,7 @@
 #include "IDetailCustomization.h"
 
 class IPropertyHandle;
+class FSlateHyperlinkRun;
 
 class FSentrySettingsCustomization : public IDetailCustomization
 {
@@ -23,9 +24,15 @@ class FSentrySettingsCustomization : public IDetailCustomization
 	void UpdateOrganizationName();
 	void UpdateAuthToken();
 
-	void UpdatePropertiesFile(const FString& PropertyName, const FString& PropertyValue); 
+	void UpdatePropertiesFile(const FString& PropertyName, const FString& PropertyValue);
+	void UpdateCrcConfig(const FString& Url);
+
+	// Gets path to CRC's DefaultEngine.ini in engine directory
+	FString GetCrcConfigPath();
 
 	TSharedPtr<IPropertyHandle> ProjectNameHandle;
 	TSharedPtr<IPropertyHandle> OrganizationNameHandle;
 	TSharedPtr<IPropertyHandle> AuthTokenHandle;
+
+	static const FString DefaultCrcEndpoint;
 };
diff --git a/sample/Config/DefaultEngine.ini b/sample/Config/DefaultEngine.ini
@@ -267,6 +267,7 @@ AutomaticBreadcrumbs=(bOnMapLoadingStarted=True,bOnMapLoaded=True,bOnGameStateCl
 UploadSymbolsAutomatically=False
 Release=
 PropertiesFilePath=Config/sentry.properties
+CrashReporterUrl="https://o447951.ingest.sentry.io/api/6253052/unreal/93c7a68867db43539980de54f09b139a/"
 
 [/Script/MacTargetPlatform.MacTargetSettings]
 SpatializationPlugin=Built-in Spatialization
diff --git a/sample/Config/DefaultGame.ini b/sample/Config/DefaultGame.ini
@@ -5,7 +5,7 @@ ProjectID=2F77D1EF624C7FE53C3E46A0AE066C2D
 [/Script/UnrealEd.ProjectPackagingSettings]
 BuildConfiguration=PPBC_Shipping
 ForDistribution=True
-IncludeCrashReporter=False
+IncludeCrashReporter=True
 IncludeDebugFiles=True
 FullRebuild=True
 

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ USentrySettings::USentrySettings(const FObjectInitializer& ObjectInitializer)`
`13`	`13`	`{`
`14`	`14`	`DsnUrl = TEXT("");`
`15`	`15`	`Release = TEXT("");`
	`16`	`+ CrashReporterUrl = TEXT("");`
`16`	`17`
`17`	`18`	`LoadDebugSymbolsProperties();`
`18`	`19`	`}`