Unity Editor support for tvOS pods and xcode projects (#478)

Updates to the Unity build process to handle tvOS pod dependencies and xcode project file configuration.

Author: DellaBitta

app/platform/Unity/PlatformInformation.cs

@@ -28,10 +28,11 @@ internal static bool IsAndroid {
     }
   }
 
-  // Is the current platform iOS?
+  // Is the current platform iOS or tvOS?
   internal static bool IsIOS {
     get {
-      return UnityEngine.Application.platform == UnityEngine.RuntimePlatform.IPhonePlayer;
+      return UnityEngine.Application.platform == UnityEngine.RuntimePlatform.IPhonePlayer ||
+         UnityEngine.Application.platform == UnityEngine.RuntimePlatform.tvOS;
     }
   }
 

app/src/ErrorMessages.cs

@@ -43,7 +43,7 @@ internal class ErrorMessages {
       "* Rebuild your APK and deploy.\n";
 
   private static string DEPENDENCY_NOT_FOUND_ERROR_IOS =
-      "On iOS, Firebase requires native (C/C++) and Cocoapod components\n" +
+      "On iOS+ Firebase requires native (C/C++) and Cocoapod components\n" +
       "that are distributed with the Firebase SDK and via Cocoapods.\n" +
       "\n" +
       "It's likely that you did not include the require Cocoapod\n" +

editor/app/src/DocRef.Designer.cs

@@ -20,7 +20,7 @@
 //
 // It also creates the google-services-desktop.json file, (used when building on
 // desktop or running in the editor) based on either the google-services.json or
-// GoogleService-Info.plist file, depending on your current build target.  (iOS
+// GoogleService-Info.plist file, depending on your current build target.  (iOS+
 // targets will prefer the GoogleService-Info.plist file, while Android build
 // targets will prefer google-services.json.)
 //
@@ -172,7 +172,7 @@ private static void UpdateJson(bool ignoreModificationDate,
       // file.
 
       // If the project is set to build for Android, the google-services.json file
-      // is preferred.  If it is set to build for iOS, the GoogleServices-Info.plist
+      // is preferred.  If it is set to build for iOS+, the GoogleServices-Info.plist
       // file is preferred.  When set to standalone desktop, it tries to match the
       // current bundleid, and if it can't, it takes any plist/json file it can find.
 
@@ -201,7 +201,8 @@ private static void UpdateJson(bool ignoreModificationDate,
         // Regenerate google-services-desktop file.
         switch (EditorUserBuildSettings.selectedBuildTargetGroup) {
           case BuildTargetGroup.iOS:
-            // If we're on iOS, generate the desktop file from the plist, if possible.
+          case BuildTargetGroup.tvOS:
+            // If we're on iOS+, generate the desktop file from the plist, if possible.
             if (googleServiceInfoFile != null) {
               CreateDesktopJsonFromPlist(googleServiceInfoFile);
             } else if (googleServicesFile != null) {
@@ -229,7 +230,8 @@ private static void UpdateJson(bool ignoreModificationDate,
         logMessageForNoConfigFiles(
             String.Format(DocRef.GoogleServicesFileBundleIdMissing,
                 GetAndroidApplicationId(),
-                EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.iOS ?
+                (EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.iOS ||
+                 EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.tvOS) ?
                     "GoogleService-Info.plist" : "google-services.json",
                 String.Join("\n", BundleIdsFromBundleIdsByConfigFile(
                     ConfigFileDirectory).ToArray()),
@@ -465,10 +467,11 @@ private static void UpdateJsonWithBundleIdChooserDialog(string bundleId,
       ConfigFileType fileType;
       if (EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.Android) {
         fileType = ConfigFileType.Json;
-      } else if (EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.iOS) {
+      } else if (EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.iOS ||
+                 EditorUserBuildSettings.selectedBuildTargetGroup == BuildTargetGroup.tvOS) {
         fileType = ConfigFileType.Plist;
       } else {
-        // Don't need to be here, if we're not on iOS or Android.
+        // Don't need to be here, if we're not on iOS+ or Android.
         return;
       }
       var configFile = FindGoogleServicesFile(fileType, bundleId,

editor/app/src/GenerateXmlFromGoogleServicesJson.cs

@@ -203,9 +203,8 @@ private static bool ContainsUrlScheme(object inputTypes, string scheme) {
   // the methods. Once that is complete it saves the modifications back over the original files.
   [PostProcessBuild]
   internal static void PostProcessBuild(BuildTarget buildTarget, string pathToBuiltProject) {
-    // BuiltTarget.iOS is not defined in Unity 4, so we just use strings here
-    if (buildTarget.ToString() != "iOS" && buildTarget.ToString() != "iPhone") {
-      logger.LogDebug("Skipping PostProcessBuild as target {0} is not for iOS", buildTarget);
+    if (buildTarget != BuildTarget.iOS && buildTarget != BuildTarget.tvOS) {
+      logger.LogDebug("Skipping PostProcessBuild as target {0} is not for iOS+", buildTarget);
       return;
     }
 

editor/app/src/XcodeProjectModifier.cs

@@ -64,20 +64,23 @@ internal class XcodeProjectPatcher : AssetPostprocessor {
     private static bool Enabled {
         get {
             return (EditorUserBuildSettings.activeBuildTarget ==
-                    BuildTarget.iOS) && Google.IOSResolver.Enabled;
+                    BuildTarget.iOS ||
+                    EditorUserBuildSettings.activeBuildTarget ==
+                    BuildTarget.tvOS) && Google.IOSResolver.Enabled;
         }
     }
 
     static XcodeProjectPatcher() {
-        // Delay initialization until the build target is iOS and the editor is not in play
-        // mode.
+        // Delay initialization until the build target is iOS+ and the
+        // editor is not in play mode.
         EditorInitializer.InitializeOnMainThread(
             condition: () => {
-                return EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS &&
+                return (EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS ||
+                        EditorUserBuildSettings.activeBuildTarget == BuildTarget.tvOS) &&
                         !EditorApplication.isPlayingOrWillChangePlaymode;
             }, initializer: () => {
                 // We attempt to read the config even when the target platform isn't
-                // iOS as the project settings are surfaced in the settings window.
+                // iOS+ as the project settings are surfaced in the settings window.
                 Google.IOSResolver.RemapXcodeExtension();
                 ReadConfigOnUpdate();
                 PlayServicesResolver.BundleIdChanged -= OnBundleIdChanged;
@@ -96,15 +99,19 @@ internal static void ReadConfigOnUpdate() {
         ReadConfig(errorOnNoConfig: false);
     }
 
-    // Get the iOS bundle / application ID.
-    private static string GetIOSApplicationId() {
-      return UnityCompat.GetApplicationId(BuildTarget.iOS);
+    // Get the iOS+ bundle / application ID.
+    private static string GetIosPlusApplicationId() {
+        if (EditorUserBuildSettings.activeBuildTarget == BuildTarget.tvOS) {
+            return UnityCompat.GetApplicationId(BuildTarget.tvOS);
+        } else {
+            return UnityCompat.GetApplicationId(BuildTarget.iOS);
+        }
     }
 
     // Check the editor environment on the first update after loading this
     // module.
     private static void CheckConfiguration() {
-        CheckBundleId(GetIOSApplicationId());
+        CheckBundleId(GetIosPlusApplicationId());
         CheckBuildEnvironment();
     }
 
@@ -115,9 +122,9 @@ internal static void ReadConfig(bool errorOnNoConfig = true, string filename = n
             ReadConfigInternal(errorOnNoConfig, filename: filename);
         } catch (Exception exception) {
             // FileNotFoundException and TypeInitializationException can be
-            // thrown *before* ReadConfigInternal is entered if the iOS Xcode
+            // thrown *before* ReadConfigInternal is entered if the iOS+ Xcode
             // assembly can't be loaded so we catch them here and only report
-            // a warning if this module is enabled and iOS is the selected
+            // a warning if this module is enabled and iOS+ is the selected
             // platform.
             if (exception is FileNotFoundException ||
                 exception is TypeInitializationException) {
@@ -158,11 +165,13 @@ internal static Dictionary<string, string> GetConfig() {
         return configValues;
     }
 
-    // Verify that the build environment *really* supports iOS.
+    // Verify that the build environment *really* supports iOS+.
     private static void CheckBuildEnvironment() {
-        // If iOS is the selected build target but we're not on a OSX machine
-        // report an error as pod installation will fail among other things.
-        if (EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS &&
+        // If iOS+ is the selected build target but we're not on a OSX
+        // machine report an error as pod installation will fail among other
+        // things.
+        BuildTarget buildTarget = EditorUserBuildSettings.activeBuildTarget;
+        if ((buildTarget == BuildTarget.iOS || buildTarget == BuildTarget.tvOS) &&
             Application.platform == RuntimePlatform.WindowsEditor) {
             Debug.LogError(DocRef.IOSNotSupportedOnWindows);
         }
@@ -173,7 +182,7 @@ private static void OnBundleIdChanged(
             object sender,
             PlayServicesResolver.BundleIdChangedEventArgs args) {
         ReadConfig(errorOnNoConfig: false);
-        CheckBundleId(GetIOSApplicationId());
+        CheckBundleId(GetIosPlusApplicationId());
     }
 
     // Check the bundle ID
@@ -213,10 +222,16 @@ private static string CheckBundleId(string bundleId,
                     "Cancel",
                     selectedBundleId => {
                         if (!String.IsNullOrEmpty(selectedBundleId)) {
-                            // If we have a valid value, the user hit apply.
-                            UnityCompat.SetApplicationId(BuildTarget.iOS, selectedBundleId);
-                            Measurement.ReportWithBuildTarget("bundleidmismatch/apply", null,
-                                                              "Mismatched Bundle ID: Apply");
+                            switch(EditorUserBuildSettings.activeBuildTarget) {
+                                case BuildTarget.iOS:
+                                    UnityCompat.SetApplicationId(BuildTarget.iOS, selectedBundleId);
+                                    break;
+                                case BuildTarget.tvOS:
+                                    UnityCompat.SetApplicationId(BuildTarget.tvOS, selectedBundleId);
+                                    break;
+                                default:
+                                    throw new Exception("unsupported iOS+ version");
+                            }
                         } else {
                             Measurement.ReportWithBuildTarget("bundleidmismatch/cancel", null,
                                                               "Mismatched Bundle ID: Cancel");
@@ -238,7 +253,7 @@ private static string CheckBundleId(string bundleId,
     private static void OnPostprocessAllAssets(
             string[] importedAssets, string[] deletedAssets,
             string[] movedAssets, string[] movedFromPath) {
-        // We track the config file state even when the target isn't iOS
+        // We track the config file state even when the target isn't iOS+
         // as the project settings are surfaced in the settings window.
         if (!Enabled) return;
         bool configFilePresent = false;
@@ -251,7 +266,7 @@ private static void OnPostprocessAllAssets(
         if (configFilePresent) {
             spamguard = false; // Reset our spamguard to show a dialog.
             ReadConfig(errorOnNoConfig: false);
-            CheckBundleId(GetIOSApplicationId());
+            CheckBundleId(GetIosPlusApplicationId());
         }
     }
 
@@ -283,7 +298,7 @@ internal static string FindConfig(bool errorOnNoConfig = true) {
                         GOOGLE_SERVICES_INFO_PLIST_FILE, Link.IOSAddApp));
             }
         } else if (files.Length > 1) {
-            var bundleId = GetIOSApplicationId();
+            var bundleId = GetIosPlusApplicationId();
             string selectedBundleId = null;
             // Search files for the first file matching the project's bundle identifier.
             foreach (var filename in files) {
@@ -314,7 +329,9 @@ internal static string FindConfig(bool errorOnNoConfig = true) {
     internal static void OnPostProcessAddGoogleServicePlist(
             BuildTarget buildTarget, string pathToBuiltProject) {
         if (!Enabled) return;
-        Measurement.analytics.Report("ios/xcodepatch", "iOS Xcode Project Patcher: Start");
+        string platform = (buildTarget == BuildTarget.iOS) ? "iOS" : "tvOS";
+        Measurement.analytics.Report("ios/xcodepatch",
+            platform + " Xcode Project Patcher: Start");
         AddGoogleServicePlist(buildTarget, pathToBuiltProject);
     }
 
@@ -331,7 +348,7 @@ internal static void AddGoogleServicePlist(
             return;
         }
 
-        CheckBundleId(GetIOSApplicationId(), promptUpdate: false);
+        CheckBundleId(GetIosPlusApplicationId(), promptUpdate: false);
 
         // Copy the config file to the Xcode project folder.
         string configFileBasename = Path.GetFileName(configFile);

editor/app/src/XcodeProjectPatcher.cs

@@ -68,19 +68,19 @@ public class iOSPostBuild {
     /// </param>
     [PostProcessBuild(100)]
     public static void OnPostprocessBuild(BuildTarget buildTarget, string buildPath) {
-      // BuiltTarget.iOS is not defined in Unity 4, so we just use strings here
-      if (buildTarget.ToString() == "iOS" || buildTarget.ToString() == "iPhone") {
+      if (buildTarget == BuildTarget.iOS || buildTarget == BuildTarget.tvOS) {
         string projectPath = Path.Combine(buildPath, "Unity-iPhone.xcodeproj/project.pbxproj");
         string plistPath = Path.Combine(buildPath, "Info.plist");
 
         IFirebaseConfigurationStorage configurationStorage = StorageProvider.ConfigurationStorage;
 
-        PrepareProject(projectPath, configurationStorage);
+        PrepareProject(projectPath, configurationStorage, buildTarget);
         AddCrashlyticsDevelopmentPlatformToPlist(plistPath);
       }
     }
 
-    private static void PrepareProject(string projectPath, IFirebaseConfigurationStorage configurationStorage) {
+    private static void PrepareProject(string projectPath, IFirebaseConfigurationStorage configurationStorage,
+                                       BuildTarget buildTarget) {
       // Return if we have already added the script
       var xcodeProjectLines = File.ReadAllLines(projectPath);
       foreach (var line in xcodeProjectLines) {
@@ -96,7 +96,7 @@ private static void PrepareProject(string projectPath, IFirebaseConfigurationSto
 
       string completeRunScriptBody = GetRunScriptBody(configurationStorage);
 
-      string appGUID = iOSPostBuild.GetMainUnityProjectTargetGuid(pbxProject);
+      string appGUID = iOSPostBuild.GetMainUnityProjectTargetGuid(pbxProject, buildTarget);
       SetupGUIDForSymbolUploads(pbxProject, completeRunScriptBody, appGUID);
 
       // In older versions of Unity there is no separate framework GUID, so this can
@@ -183,7 +183,7 @@ private static string GetUnityFrameworkTargetGuid(object projectObj) {
     /// </summary>
     /// <param name="projectObj">The project where the main target GUID will be read from</param>
     /// <returns>The main target GUID</returns>
-    private static string GetMainUnityProjectTargetGuid(object projectObj) {
+    private static string GetMainUnityProjectTargetGuid(object projectObj, BuildTarget buildTarget) {
       var project = (UnityEditor.iOS.Xcode.PBXProject)projectObj;
       MethodInfo getUnityMainTargetGuid =  project.GetType().GetMethod("GetUnityMainTargetGuid");
 
@@ -194,7 +194,7 @@ private static string GetMainUnityProjectTargetGuid(object projectObj) {
       } else {
         // Hardcode the main target name "Unity-iPhone" by default, just in case
         // GetUnityTargetName() is not available.
-        string targetName = "Unity-iPhone";
+        string targetName = (buildTarget == BuildTarget.tvOS) ? "Unity-tvOS" : "Unity-iPhone";
         MethodInfo getUnityTargetName =  project.GetType().GetMethod("GetUnityTargetName");
         if (getUnityTargetName != null) {
           targetName = (string) getUnityTargetName.Invoke(null, new object[] {});

editor/crashlytics/src/iOSPostBuild.cs

@@ -43,6 +43,23 @@ public static void BuildIos() {
     Build(options);
   }
 
+  public static void BuildTvos() {
+    var options = new BuildPlayerOptions();
+
+    // For tvOS, this is the name of the folder containing the generated XCode
+    // project.
+    options.locationPathName = "tvos-build";
+    options.target = BuildTarget.tvOS;
+    // Firebase Unity plugins don't seem to work on a simulator.
+    PlayerSettings.tvOS.sdkVersion = tvOSSdkVersion.DeviceSDK;
+
+    // AcceptExternalModificationsToPlayer corresponds to "Append" in the Unity
+    // UI -- it allows doing incremental builds.
+    options.options = BuildOptions.AcceptExternalModificationsToPlayer;
+
+    Build(options);
+  }
+
   public static void BuildAndroid() {
     var options = new BuildPlayerOptions();