feat: Android Native Support (#307)

Co-authored-by: Sentry Github Bot <[email protected]>

Author: bruno-garcia

.gitignore

@@ -21,6 +21,8 @@ samples/unity-of-bugs/Assets/InitTestScene*
 package-dev/**/*.dll
 package-dev/**/*.meta
 package-dev/**/*.framework
+# Android SDK files
+package-dev/Plugins/Android/Sentry/*
 # required to be makred as iOS only
 !package-dev/**/*.framework.meta
 !package-dev/Runtime/Sentry.Unity.dll.meta

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "src/sentry-cocoa"]
 	path = src/sentry-cocoa
 	url = https://github.com/getsentry/sentry-cocoa
+[submodule "src/sentry-java"]
+	path = src/sentry-java
+	url = https://github.com/getsentry/sentry-java.git

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Feature
+
+- Android Native Support ([#307](https://github.com/getsentry/sentry-unity/pull/307))
+
 ### Fixes
 
 - Import link.xml caused an infinite loop ([#315](https://github.com/getsentry/sentry-unity/pull/315))

Directory.Build.targets

@@ -10,9 +10,12 @@
     <UnitySampleProjectUnityVersion>$(SolutionDir)samples/unity-of-bugs/ProjectSettings/ProjectVersion.txt</UnitySampleProjectUnityVersion>
     <UnityTestPlayModeResultFilePath>../../artifacts/test/playmode/results.xml</UnityTestPlayModeResultFilePath>
     <UnityTestEditModeResultFilePath>../../artifacts/test/editmode/results.xml</UnityTestEditModeResultFilePath>
-    <!-- Cocoa-->
-    <CocoaRoot>$(SolutionDir)src/sentry-cocoa/</CocoaRoot>
-    <CocoaFrameworkDestination>$(SolutionDir)package-dev/Plugins/iOS/Sentry.framework/</CocoaFrameworkDestination>
+    <!-- Cocoa -->
+    <SentryCocoaRoot>$(SolutionDir)src/sentry-cocoa/</SentryCocoaRoot>
+    <SentryCocoaArtifactsDestination>$(SolutionDir)package-dev/Plugins/iOS/Sentry.framework/</SentryCocoaArtifactsDestination>
+    <!-- Android -->
+    <SentryAndroidRoot>$(SolutionDir)src/sentry-java/</SentryAndroidRoot>
+    <SentryAndroidArtifactsDestination>$(SolutionDir)package-dev/Plugins/Android/Sentry/</SentryAndroidArtifactsDestination>
   </PropertyGroup>
 
   <!-- Use the Unity Editor version set in the sample project of the repo -->
@@ -56,29 +59,59 @@
     <RemoveDir Directories="$(UnityPackageProject)" />
   </Target>
 
-  <Target Name="CleanCocoaSDK" AfterTargets="Clean" Condition="Exists('$(CocoaFrameworkDestination)')">
-    <RemoveDir Directories="$(CocoaFrameworkPath)Sentry.framework" />
+  <Target Name="CleanCocoaSDK" AfterTargets="Clean" Condition="Exists('$(SentryCocoaArtifactsDestination)')">
+    <RemoveDir Directories="$(SentryCocoaArtifactsDestination)" ContinueOnError="true" />
+  </Target>
+
+  <Target Name="CleanAndroidSDK" AfterTargets="Clean" Condition="Exists('$(SentryAndroidArtifactsDestination)')">
+    <RemoveDir Directories="$(SentryAndroidArtifactsDestination)" ContinueOnError="true" />
   </Target>
 
   <!-- Build the iOS SDK: dotnet msbuild /t:BuildCocoaSDK -->
   <Target Name="BuildCocoaSDK" 
           Condition="$([MSBuild]::IsOSPlatform('OSX')) 
           And '$(MSBuildProjectName)' == 'Sentry.Unity'
-          And !Exists('$(CocoaFrameworkDestination)')" 
+          And !Exists('$(SentryCocoaArtifactsDestination)')"
           BeforeTargets="BeforeBuild">    
-    <Error Condition="!Exists('$(CocoaRoot)')" Text="Couldn't find the Cocoa root at $(CocoaRoot)."></Error>      
+    <Error Condition="!Exists('$(SentryCocoaRoot)')" Text="Couldn't find the Cocoa root at $(SentryCocoaRoot)."></Error>
+    <Message Importance="High" Text="Building Sentry iOS SDK."></Message>
 
-    <Exec WorkingDirectory="$(CocoaRoot)" Command="carthage build --use-xcframeworks --no-skip-current --platform iOS"></Exec>
+    <Exec WorkingDirectory="$(SentryCocoaRoot)" Command="carthage build --use-xcframeworks --no-skip-current --platform iOS"></Exec>
 
     <!-- Itemgroup for the output Sentry.framework so we have access to '%(RecursiveDir)' when copying -->
     <ItemGroup>
-      <CocoaBuildPath Include="$(CocoaRoot)Carthage/Build/Sentry.xcframework/ios-arm64_armv7/Sentry.framework/**/*" />
+      <CocoaBuildPath Include="$(SentryCocoaRoot)Carthage/Build/Sentry.xcframework/ios-arm64_armv7/Sentry.framework/**/*" />
     </ItemGroup>    
     <Copy SourceFiles="@(CocoaBuildPath)"
-          DestinationFiles="@(CocoaBuildPath->'$(CocoaFrameworkDestination)%(RecursiveDir)%(Filename)%(Extension)')">
+          DestinationFiles="@(CocoaBuildPath->'$(SentryCocoaArtifactsDestination)%(RecursiveDir)%(Filename)%(Extension)')">
+    </Copy>
+
+    <Error Condition="!Exists('$(SentryCocoaArtifactsDestination)')" Text="Failed to build the Cocoa SDK."></Error>
+  </Target>
+
+  <!-- Build the Android SDK: dotnet msbuild /t:BuildAndroidSDK -->
+  <Target Name="BuildAndroidSDK"
+          Condition="'$(MSBuildProjectName)' == 'Sentry.Unity'
+          And !Exists('$(SentryAndroidArtifactsDestination)')"
+          BeforeTargets="BeforeBuild">
+    <Error Condition="!Exists('$(SentryAndroidRoot)')" Text="Couldn't find the Android root at $(SentryAndroidRoot)."></Error>
+    <Message Importance="High" Text="Building Sentry Android SDK."></Message>
+
+    <Exec WorkingDirectory="$(SentryAndroidRoot)" Command="./gradlew :sentry-android-core:assembleRelease :sentry-android-ndk:assembleRelease :sentry:jar"></Exec>
+
+    <ItemGroup>
+      <!-- building snapshot based on version, i.e: sentry-5.0.0-beta.3-SNAPSHOT.jar -->
+      <AndroidSdkArtifacts Include="$(SentryAndroidRoot)sentry/build/libs/sentry*.jar" />
+      <AndroidSdkArtifacts Include="$(SentryAndroidRoot)sentry-android-ndk/build/outputs/aar/sentry-android-ndk-release.aar" />
+      <AndroidSdkArtifacts Include="$(SentryAndroidRoot)sentry-android-core/build/outputs/aar/sentry-android-core-release.aar" />
+      <AndroidSdkArtifacts Include="$(SolutionDir)lib/gson-2.8.5.jar" />
+    </ItemGroup>
+
+    <Copy SourceFiles="@(AndroidSdkArtifacts)"
+          DestinationFiles="@(AndroidSdkArtifacts->'$(SentryAndroidArtifactsDestination)%(RecursiveDir)%(Filename)%(Extension)')">
     </Copy>
 
-    <Error Condition="!Exists('$(CocoaFrameworkDestination)')" Text="Failed to build the Cocoa SDK."></Error>
+    <Error Condition="!Exists('$(SentryAndroidArtifactsDestination)')" Text="Failed to build the Android SDK."></Error>
   </Target>
 
   <!-- Even with a successful build, Unity will error on 'usbmuxd' or log out to std-error which breaks msbuild.

before.Sentry.Unity.sln.targets

@@ -2,6 +2,7 @@
   <!-- If sentry-dotnet is not found, restore git submodules -->
   <Target Name="RestoreSubmodules"
     Condition="!Exists('src/sentry-dotnet/src/Sentry/Sentry.csproj') 
+            OR !Exists('src/sentry-java/build.gradle.kts')
             OR !Exists('src/sentry-cocoa/Sentry.xcodeproj')">
     <Message Importance="High" Text="Restoring git submodules."></Message>
     <Exec Command="git submodule update --init --recursive"></Exec>

lib/README.md

@@ -0,0 +1,7 @@
+`gson` is a dependency of Sentry Android and is planned to be removed.
+
+While it is still a dependency, we'll copy from here when assembling the Unity package in combination with the Sentry SDK for Android.
+
+From: https://search.maven.org/remotecontent?filepath=com/google/code/gson/gson/2.8.5/gson-2.8.5.jar
+
+[Version defined in buildSrc](../src/sentry-java/buildSrc/src/main/java/Config.kt)

lib/gson-2.8.5.jar

@@ -1,3 +1,3 @@
 <Project>
-    <!-- Stops msbuild from looking on the part directory. Can't deal with the properties set such as C# 9 -->
+    <!-- Stops msbuild from looking on the parent directory. Can't deal with the properties set such as C# 9 -->
 </Project>

samples/Directory.Build.props

@@ -1,3 +1,3 @@
 <Project>
-  <!-- Stops msbuild from looking on the part directory. Can't deal with the properties set such as C# 9 -->
+  <!-- Stops msbuild from looking on the parent directory. Can't deal with the properties set such as C# 9 -->
 </Project>

samples/Directory.Build.targets

@@ -31,6 +31,7 @@ MonoBehaviour:
   <ShutdownTimeout>k__BackingField: 2000
   <MaxQueueItems>k__BackingField: 30
   <IOSNativeSupportEnabled>k__BackingField: 1
+  <AndroidNativeSupportEnabled>k__BackingField: 1
   <Debug>k__BackingField: 1
   <DebugOnlyInEditor>k__BackingField: 1
   <DiagnosticLevel>k__BackingField: 0