Skip to content

Commit 3f179e5

Browse files
bitsandfoxesbitsandfoxes
authored
feat: Added iOS simulator support (#358)
1 parent 4e0c97c commit 3f179e5

File tree

7 files changed

+164
-91
lines changed

7 files changed

+164
-91
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
### Features
1414

15+
- Added iOS simulator support ([#358](https://github.com/getsentry/sentry-unity/pull/358))
1516
- Android Native Support ([#307](https://github.com/getsentry/sentry-unity/pull/307))
1617
- Android mark sessions as crashed ([#347](https://github.com/getsentry/sentry-unity/pull/347))
1718
- Android native bridge for scope sync ([#308](https://github.com/getsentry/sentry-unity/pull/308))

‎Directory.Build.targets

+17-7
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
<UnityTestEditModeResultFilePath>../../artifacts/test/editmode/results.xml</UnityTestEditModeResultFilePath>
1313
<!-- Cocoa -->
1414
<SentryCocoaRoot>$(SolutionDir)src/sentry-cocoa/</SentryCocoaRoot>
15-
<SentryCocoaArtifactsDestination>$(SolutionDir)package-dev/Plugins/iOS/Sentry.framework/</SentryCocoaArtifactsDestination>
15+
<SentryCocoaDeviceArtifactsDestination>$(SolutionDir)package-dev/Plugins/iOS/Device/Sentry.framework/</SentryCocoaDeviceArtifactsDestination>
16+
<SentryCocoaSimulatorArtifactsDestination>$(SolutionDir)package-dev/Plugins/iOS/Simulator/Sentry.framework/</SentryCocoaSimulatorArtifactsDestination>
1617
<!-- Android -->
1718
<SentryAndroidRoot>$(SolutionDir)src/sentry-java/</SentryAndroidRoot>
1819
<SentryAndroidArtifactsDestination>$(SolutionDir)package-dev/Plugins/Android/Sentry/</SentryAndroidArtifactsDestination>
@@ -81,7 +82,8 @@ or
8182
</Target>
8283

8384
<Target Name="CleanCocoaSDK" AfterTargets="Clean" Condition="'$(MSBuildProjectName)' == 'Sentry.Unity'">
84-
<RemoveDir Directories="$(SentryCocoaArtifactsDestination)" ContinueOnError="true" />
85+
<RemoveDir Directories="$(SentryCocoaDeviceArtifactsDestination)" ContinueOnError="true" />
86+
<RemoveDir Directories="$(SentryCocoaSimulatorArtifactsDestination)" ContinueOnError="true" />
8587
</Target>
8688

8789
<Target Name="CleanAndroidSDK" AfterTargets="Clean" Condition="'$(MSBuildProjectName)' == 'Sentry.Unity'">
@@ -94,7 +96,7 @@ or
9496
<Target Name="BuildCocoaSDK"
9597
Condition="$([MSBuild]::IsOSPlatform('OSX'))
9698
And '$(MSBuildProjectName)' == 'Sentry.Unity'
97-
And !Exists('$(SentryCocoaArtifactsDestination)')"
99+
And (!Exists('$(SentryCocoaDeviceArtifactsDestination)') OR !Exists('$(SentryCocoaSimulatorArtifactsDestination)'))"
98100
BeforeTargets="BeforeBuild">
99101
<Error Condition="!Exists('$(SentryCocoaRoot)')" Text="Couldn't find the Cocoa root at $(SentryCocoaRoot)."></Error>
100102
<Message Importance="High" Text="Building Sentry iOS SDK."></Message>
@@ -103,13 +105,21 @@ or
103105

104106
<!-- Itemgroup for the output Sentry.framework so we have access to '%(RecursiveDir)' when copying -->
105107
<ItemGroup>
106-
<CocoaBuildPath Include="$(SentryCocoaRoot)Carthage/Build/Sentry.xcframework/ios-arm64_armv7/Sentry.framework/**/*" />
108+
<CocoaDeviceBuildPath Include="$(SentryCocoaRoot)Carthage/Build/Sentry.xcframework/ios-arm64_armv7/Sentry.framework/**/*" />
107109
</ItemGroup>
108-
<Copy SourceFiles="@(CocoaBuildPath)"
109-
DestinationFiles="@(CocoaBuildPath->'$(SentryCocoaArtifactsDestination)%(RecursiveDir)%(Filename)%(Extension)')">
110+
<Copy SourceFiles="@(CocoaDeviceBuildPath)"
111+
DestinationFiles="@(CocoaDeviceBuildPath->'$(SentryCocoaDeviceArtifactsDestination)%(RecursiveDir)%(Filename)%(Extension)')">
112+
</Copy>
113+
<ItemGroup>
114+
<CocoaSimulatorBuildPath Include="$(SentryCocoaRoot)Carthage/Build/Sentry.xcframework/ios-arm64_i386_x86_64-simulator/Sentry.framework/**/*" />
115+
</ItemGroup>
116+
<Copy SourceFiles="@(CocoaSimulatorBuildPath)"
117+
DestinationFiles="@(CocoaSimulatorBuildPath->'$(SentryCocoaSimulatorArtifactsDestination)%(RecursiveDir)%(Filename)%(Extension)')">
110118
</Copy>
111119

112-
<Error Condition="!Exists('$(SentryCocoaArtifactsDestination)')" Text="Failed to build the Cocoa SDK."></Error>
120+
<Error Condition="(!Exists('$(SentryCocoaDeviceArtifactsDestination)') OR !Exists('$(SentryCocoaSimulatorArtifactsDestination)'))"
121+
Text="Failed to build the Cocoa SDK.">
122+
</Error>
113123
</Target>
114124

115125
<!-- Build the Android SDK: dotnet msbuild /t:BuildAndroidSDK -->

‎package-dev/Plugins/iOS/Sentry.framework.meta ‎package-dev/Plugins/iOS/Device/Sentry.framework.meta

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package-dev/Plugins/iOS/Simulator/Sentry.framework.meta

+81
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Sentry.Unity.Editor.iOS/BuildPostProcess.cs

+51
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System;
2+
using System.IO;
23
using Sentry.Extensibility;
34
using UnityEditor;
45
using UnityEditor.Callbacks;
@@ -7,6 +8,9 @@ namespace Sentry.Unity.Editor.iOS
78
{
89
public static class BuildPostProcess
910
{
11+
private static string PackageName = "io.sentry.unity";
12+
private static string PackageNameDev = "io.sentry.unity.dev";
13+
1014
[PostProcessBuild(1)]
1115
public static void OnPostProcessBuild(BuildTarget target, string pathToProject)
1216
{
@@ -19,6 +23,8 @@ public static void OnPostProcessBuild(BuildTarget target, string pathToProject)
1923

2024
try
2125
{
26+
CopyFrameworkToBuildDirectory(pathToProject, options?.DiagnosticLogger);
27+
2228
using var sentryXcodeProject = SentryXcodeProject.Open(pathToProject);
2329
sentryXcodeProject.AddSentryFramework();
2430

@@ -42,5 +48,50 @@ public static void OnPostProcessBuild(BuildTarget target, string pathToProject)
4248
options?.DiagnosticLogger?.LogError("Failed to add the Sentry framework to the generated Xcode project", e);
4349
}
4450
}
51+
52+
private static void CopyFrameworkToBuildDirectory(string pathToProject, IDiagnosticLogger? logger)
53+
{
54+
var targetPath = Path.Combine(pathToProject, "Frameworks", "Sentry.framework");
55+
if (Directory.Exists(targetPath))
56+
{
57+
// If the target path already exists we can bail. Unity doesn't allow an appending builds when switching
58+
// iOS SDK versions and this will make sure we always copy the correct version of the Sentry.framework
59+
logger?.LogDebug("'Sentry.framework' has already copied to '{0}'", targetPath);
60+
return;
61+
}
62+
63+
var packageName = GetPackageName();
64+
var frameworkDirectory = PlayerSettings.iOS.sdkVersion == iOSSdkVersion.DeviceSDK ? "Device" : "Simulator";
65+
66+
var frameworkPath = Path.Combine("Packages", packageName, "Plugins", "iOS", frameworkDirectory, "Sentry.framework");
67+
if (Directory.Exists(frameworkPath))
68+
{
69+
logger?.LogDebug("Copying Sentry.framework from '{0}' to '{1}'", frameworkPath, targetPath);
70+
71+
Directory.CreateDirectory(Path.Combine(pathToProject, "Frameworks"));
72+
FileUtil.CopyFileOrDirectoryFollowSymlinks(frameworkPath, targetPath);
73+
}
74+
else
75+
{
76+
throw new FileNotFoundException($"Failed to copy 'Sentry.framework' from '{frameworkPath}' to Xcode project");
77+
}
78+
}
79+
80+
private static string GetPackageName()
81+
{
82+
var packagePath = Path.Combine("Packages", PackageName);
83+
if (Directory.Exists(Path.Combine(packagePath)))
84+
{
85+
return PackageName;
86+
}
87+
88+
packagePath = Path.Combine("Packages", PackageNameDev);
89+
if (Directory.Exists(Path.Combine(packagePath)))
90+
{
91+
return PackageNameDev;
92+
}
93+
94+
throw new FileNotFoundException("Failed to locate the Sentry package");
95+
}
4596
}
4697
}

‎src/Sentry.Unity.Editor.iOS/SentryXcodeProject.cs

+12-33
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,11 @@ internal class SentryXcodeProject : IDisposable
1111

1212
private readonly string _mainPath = Path.Combine("MainApp", "main.mm");
1313
private readonly string _optionsPath = Path.Combine("MainApp", "SentryOptions.m");
14-
private readonly string _unityPackageFrameworkRoot = Path.Combine("Frameworks", "io.sentry.unity");
1514

1615
private readonly string _projectRoot;
1716
private readonly PBXProject _project;
1817
private readonly string _projectPath;
1918

20-
internal string? RelativeFrameworkPath { get; set; }
21-
2219
private readonly INativeMain _nativeMain;
2320
private readonly INativeOptions _nativeOptions;
2421

@@ -42,7 +39,6 @@ public static SentryXcodeProject Open(string path)
4239
{
4340
var xcodeProject = new SentryXcodeProject(path);
4441
xcodeProject.ReadFromProjectFile();
45-
xcodeProject.SetRelativeFrameworkPath();
4642

4743
return xcodeProject;
4844
}
@@ -57,42 +53,25 @@ internal void ReadFromProjectFile()
5753
_project.ReadFromString(File.ReadAllText(_projectPath));
5854
}
5955

60-
internal void SetRelativeFrameworkPath()
61-
{
62-
if (Directory.Exists(Path.Combine(_projectRoot, _unityPackageFrameworkRoot)))
63-
{
64-
RelativeFrameworkPath = Path.Combine(_unityPackageFrameworkRoot, "Plugins", "iOS");
65-
return;
66-
}
67-
68-
// For dev purposes - The framework path contains the package name
69-
var relativeFrameworkPath = _unityPackageFrameworkRoot + ".dev";
70-
if (Directory.Exists(Path.Combine(_projectRoot, relativeFrameworkPath)))
71-
{
72-
RelativeFrameworkPath = Path.Combine(relativeFrameworkPath, "Plugins", "iOS");
73-
return;
74-
}
75-
76-
throw new FileNotFoundException("Could not locate the Sentry package inside the 'Frameworks' directory");
77-
}
78-
7956
public void AddSentryFramework()
8057
{
81-
var targetGuid = _project.GetUnityMainTargetGuid();
82-
var frameworkPath = Path.Combine(RelativeFrameworkPath, FrameworkName);
58+
var frameworkPath = Path.Combine(_projectRoot, "Frameworks", FrameworkName);
8359
var frameworkGuid = _project.AddFile(frameworkPath, frameworkPath);
8460

85-
var unityLinkPhaseGuid = _project.GetFrameworksBuildPhaseByTarget(targetGuid);
61+
var mainTargetGuid = _project.GetUnityMainTargetGuid();
62+
var unityFrameworkTargetGuid = _project.GetUnityFrameworkTargetGuid();
63+
64+
_project.AddFrameworkToProject(mainTargetGuid, FrameworkName, false);
65+
_project.AddFrameworkToProject(unityFrameworkTargetGuid, FrameworkName, false);
8666

87-
_project.AddFileToBuildSection(targetGuid, unityLinkPhaseGuid,
88-
frameworkGuid); // Link framework in 'Build Phases > Link Binary with Libraries'
89-
_project.AddFileToEmbedFrameworks(targetGuid,
90-
frameworkGuid); // Embedding the framework because it's dynamic and needed at runtime
67+
_project.AddFileToEmbedFrameworks(mainTargetGuid, frameworkGuid); // Embedding the framework because it's dynamic and needed at runtime
9168

92-
_project.SetBuildProperty(targetGuid, "FRAMEWORK_SEARCH_PATHS", "$(inherited)");
93-
_project.AddBuildProperty(targetGuid, "FRAMEWORK_SEARCH_PATHS", $"$(PROJECT_DIR)/{RelativeFrameworkPath}/");
69+
_project.SetBuildProperty(mainTargetGuid, "FRAMEWORK_SEARCH_PATHS", "$(inherited)");
70+
_project.AddBuildProperty(mainTargetGuid, "FRAMEWORK_SEARCH_PATHS", "$(PROJECT_DIR)/Frameworks/");
71+
_project.SetBuildProperty(unityFrameworkTargetGuid, "FRAMEWORK_SEARCH_PATHS", "$(inherited)");
72+
_project.AddBuildProperty(unityFrameworkTargetGuid, "FRAMEWORK_SEARCH_PATHS", "$(PROJECT_DIR)/Frameworks/");
9473

95-
_project.AddBuildProperty(targetGuid, "OTHER_LDFLAGS", "-ObjC");
74+
_project.AddBuildProperty(mainTargetGuid, "OTHER_LDFLAGS", "-ObjC");
9675
}
9776

9877
public void AddNativeOptions(SentryUnityOptions options)

‎test/Sentry.Unity.Editor.iOS.Tests/SentryXcodeProjectTests.cs

-49
Original file line numberDiff line numberDiff line change
@@ -62,47 +62,11 @@ public void ReadFromProjectFile_ProjectDoesNotExist_ThrowsFileNotFoundException(
6262
Assert.Throws<FileNotFoundException>(() => xcodeProject.ReadFromProjectFile());
6363
}
6464

65-
[Test]
66-
public void SetRelativeFrameworkPath_PathExists_ReturnsFrameworkPath()
67-
{
68-
CreateFrameworkDirectories();
69-
70-
var xcodeProject = _fixture.GetSut();
71-
var expectedFrameworkPath = Path.Combine("Frameworks", "io.sentry.unity", "Plugins", "iOS");
72-
73-
xcodeProject.SetRelativeFrameworkPath();
74-
75-
Assert.AreEqual(expectedFrameworkPath, xcodeProject.RelativeFrameworkPath);
76-
}
77-
78-
[Test]
79-
public void SetRelativeFrameworkPath_DevPathExists_ReturnsDevFrameworkPath()
80-
{
81-
CreateDevFrameworkDirectories();
82-
83-
var xcodeProject = _fixture.GetSut();
84-
var expectedFrameworkPath = Path.Combine("Frameworks", "io.sentry.unity.dev", "Plugins", "iOS");
85-
86-
xcodeProject.SetRelativeFrameworkPath();
87-
88-
Assert.AreEqual(expectedFrameworkPath, xcodeProject.RelativeFrameworkPath);
89-
}
90-
91-
[Test]
92-
public void SetRelativeFrameworkPath_PathDoesNotExist_ThrowsFileNotFoundException()
93-
{
94-
_fixture.ProjectRoot = "Path/That/Does/Not/Exist";
95-
var xcodeProject = _fixture.GetSut();
96-
97-
Assert.Throws<FileNotFoundException>(() => xcodeProject.SetRelativeFrameworkPath());
98-
}
99-
10065
[Test]
10166
public void AddSentryFramework_CleanXcodeProject_SentryWasAdded()
10267
{
10368
var xcodeProject = _fixture.GetSut();
10469
xcodeProject.ReadFromProjectFile();
105-
xcodeProject.RelativeFrameworkPath = "Frameworks/io.sentry.unity/Plugins/iOS/";
10670

10771
xcodeProject.AddSentryFramework();
10872

@@ -114,23 +78,10 @@ public void CreateNativeOptions_CleanXcodeProject_NativeOptionsAdded()
11478
{
11579
var xcodeProject = _fixture.GetSut();
11680
xcodeProject.ReadFromProjectFile();
117-
xcodeProject.RelativeFrameworkPath = "Frameworks/io.sentry.unity/Plugins/iOS/";
11881

11982
xcodeProject.AddNativeOptions(_fixture.Options);
12083

12184
StringAssert.Contains("SentryOptions.m", xcodeProject.ProjectToString());
12285
}
123-
124-
private void CreateFrameworkDirectories()
125-
{
126-
var expectedFrameworkPath = Path.Combine("Frameworks", "io.sentry.unity", "Plugins", "iOS");
127-
Directory.CreateDirectory(Path.Combine(_fixture.ProjectRoot, expectedFrameworkPath));
128-
}
129-
130-
private void CreateDevFrameworkDirectories()
131-
{
132-
var expectedFrameworkPath = Path.Combine("Frameworks", "io.sentry.unity.dev", "Plugins", "iOS");
133-
Directory.CreateDirectory(Path.Combine(_fixture.ProjectRoot, expectedFrameworkPath));
134-
}
13586
}
13687
}

0 commit comments

Comments
 (0)