From 5cb679de8ab61b24bee79f0a790eb91d8e3365f9 Mon Sep 17 00:00:00 2001
From: bitsandfoxes <reg@bitfox.at>
Date: Thu, 30 Jun 2022 11:23:25 +0200
Subject: [PATCH] breadcrumbs on button clicks

---
 Directory.Build.props                         | 55 ++++++++++++++++++-
 .../ButtonInstrumentation.cs                  | 33 +++++++++++
 .../Sentry.Unity.Editor.csproj                |  4 ++
 src/Sentry.Unity/SentryScene.cs               | 10 ++++
 test/Directory.Build.props                    | 12 ----
 5 files changed, 101 insertions(+), 13 deletions(-)
 create mode 100644 src/Sentry.Unity.Editor/ButtonInstrumentation.cs
 create mode 100644 src/Sentry.Unity/SentryScene.cs

diff --git a/Directory.Build.props b/Directory.Build.props
index 6a763ce64..d395f16d4 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -43,10 +43,63 @@
     <Error Condition="'$(UnityManagedPath)' == ''" Text="'UnityManagedPath' not defined. Can't find UnityEngine.dll."></Error>
     <Error Condition="!Exists('$(UnityManagedPath)/UnityEngine.dll')" Text="Couldn't find UnityEngine at $(UnityManagedPath)/UnityEngine.dll."></Error>
     <ItemGroup>
+<!--      <Reference Include="UnityEngine">-->
+<!--        <HintPath>$(UnityManagedPath)/UnityEngine.dll</HintPath>-->
+<!--        <Private>false</Private>-->
+<!--      </Reference>-->
       <Reference Include="UnityEngine">
-        <HintPath>$(UnityManagedPath)/UnityEngine.dll</HintPath>
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.dll</HintPath>
         <Private>false</Private>
       </Reference>
+      <Reference Include="UnityEngine.CoreModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.CoreModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+      <Reference Include="UnityEngine.IMGUIModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.IMGUIModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+      <Reference Include="UnityEngine.ImageConversionModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.ImageConversionModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+      <Reference Include="UnityEngine.JSONSerializeModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.JSONSerializeModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+      <Reference Include="UnityEngine.ScreenCaptureModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.ScreenCaptureModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+      <Reference Include="UnityEngine.UnityWebRequestModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.UnityWebRequestModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+
+      <Reference Include="UnityEngine.AndroidJNIModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.AndroidJNIModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+
+      <Reference Include="UnityEngine.UnityAnalyticsModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.UnityAnalyticsModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+
+      <Reference Include="UnityEngine.InputLegacyModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.InputLegacyModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+
+      <Reference Include="UnityEngine.ProfilerModule">
+        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.ProfilerModule.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
+
+<!--      <Reference Include="UnityEngine.UI">-->
+<!--        <HintPath>$(UnityTemplateAssemblyPath)/UnityEngine.UI.dll</HintPath>-->
+<!--        <Private>false</Private>-->
+<!--      </Reference>-->
     </ItemGroup>
   </Target>
 </Project>
diff --git a/src/Sentry.Unity.Editor/ButtonInstrumentation.cs b/src/Sentry.Unity.Editor/ButtonInstrumentation.cs
new file mode 100644
index 000000000..6faa72645
--- /dev/null
+++ b/src/Sentry.Unity.Editor/ButtonInstrumentation.cs
@@ -0,0 +1,33 @@
+using UnityEditor.Build;
+using UnityEditor.Build.Reporting;
+using UnityEditor.Events;
+using UnityEngine.Events;
+using UnityEngine.SceneManagement;
+using UnityEngine.UI;
+
+namespace Sentry.Unity.Editor
+{
+    public class ButtonInstrumentation : IProcessSceneWithReport
+    {
+        public int callbackOrder { get; } = 0;
+
+        public void OnProcessScene(Scene scene, BuildReport report)
+        {
+            var gameObjects = scene.GetRootGameObjects();
+            if (gameObjects is { Length: > 0 })
+            {
+                var sentryScene = gameObjects[0].AddComponent<SentryScene>();
+
+                foreach (var gameObject in gameObjects)
+                {
+                    var buttons = gameObject.GetComponentsInChildren<Button>();
+                    foreach (var button in buttons)
+                    {
+                        var unityAction = new UnityAction<string>(sentryScene.AddButtonBreadcrumb);
+                        UnityEventTools.AddStringPersistentListener(button.onClick, unityAction, button.gameObject.name);
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/src/Sentry.Unity.Editor/Sentry.Unity.Editor.csproj b/src/Sentry.Unity.Editor/Sentry.Unity.Editor.csproj
index 90d687f8e..5afafb27b 100644
--- a/src/Sentry.Unity.Editor/Sentry.Unity.Editor.csproj
+++ b/src/Sentry.Unity.Editor/Sentry.Unity.Editor.csproj
@@ -20,6 +20,10 @@
         <HintPath>$(UnityManagedPath)/UnityEditor.dll</HintPath>
         <Private>false</Private>
       </Reference>
+      <Reference Include="UnityEngine.UI">
+        <HintPath>$(UnityTemplateAssemblyPath)/UnityEngine.UI.dll</HintPath>
+        <Private>false</Private>
+      </Reference>
     </ItemGroup>
   </Target>
 </Project>
diff --git a/src/Sentry.Unity/SentryScene.cs b/src/Sentry.Unity/SentryScene.cs
new file mode 100644
index 000000000..cd66e131b
--- /dev/null
+++ b/src/Sentry.Unity/SentryScene.cs
@@ -0,0 +1,10 @@
+using UnityEngine;
+
+namespace Sentry.Unity
+{
+    public class SentryScene : MonoBehaviour
+    {
+        public void AddButtonBreadcrumb(string message)
+            => SentrySdk.AddBreadcrumb(message, "unity.ui.button");
+    }
+}
diff --git a/test/Directory.Build.props b/test/Directory.Build.props
index 9fb06216f..61ae782b5 100644
--- a/test/Directory.Build.props
+++ b/test/Directory.Build.props
@@ -30,18 +30,6 @@
         <HintPath>$(UnityTemplateAssemblyPath)/UnityEngine.TestRunner.dll</HintPath>
         <Private>false</Private>
       </Reference>
-
-<!--  TODO: The parent directory contains a 'UnityEngine.dll' but that one is different? But if that one does not get -->
-<!--      referenced here and we just add the CoreModule it leads to 'ambiguous references' and 'Type exists in both -->
-<!--      'UnityEngine.CoreModule and UnityEngine' -->
-      <Reference Include="UnityEngine">
-        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.dll</HintPath>
-        <Private>false</Private>
-      </Reference>
-      <Reference Include="UnityEngine.CoreModule">
-        <HintPath>$(UnityManagedPath)/UnityEngine/UnityEngine.CoreModule.dll</HintPath>
-        <Private>false</Private>
-      </Reference>
     </ItemGroup>
     <Error Condition="!Exists('$(UnityTemplateAssemblyPath)/UnityEngine.TestRunner.dll')" Text="TestRunner not found. Expected: $(UnityTemplateAssemblyPath)/UnityEngine.TestRunner.dll"></Error>
   </Target>