Changing the Zip Builder to support the new open-source FirebaseCoreDiagnostics (#3461)

Author: davidair

ZipBuilder/README.md

@@ -40,8 +40,6 @@ These arguments assume you're running the command from the `ZipBuilder` director
 **Required** arguments:
 - `-templateDir $(pwd)/Template`
   - This should always be the same.
-- `-coreDiagnosticsDir <PATH_TO_FirebaseCoreDiagnostics.framework>`
-  - Needed to overwrite the existing Core Diagnostics framework.
 
 Optional comon arguments:
 - `-updatePodRepo false`
@@ -59,7 +57,6 @@ Putting them all together, here's a common command to build a releaseable Zip fi
 
 ```
 swift run ZipBuilder -templateDir $(pwd)/Template -updatePodRepo false \
--coreDiagnosticsDir /private/tmp/tmpUqBxKN/FirebaseCoreDiagnostics.framework \
 -releasingSDKs <PATH_TO_current.textproto> \
 -existingVersions <PATH_TO_all_firebase_ios_sdks.textproto> \
 -customSpecRepos sso://cpdc-internal/firebase

ZipBuilder/Sources/ZipBuilder/FrameworkBuilder.swift

@@ -418,7 +418,7 @@ struct FrameworkBuilder {
 
     // Verify Firebase headers include an explicit umbrella header for Firebase.h.
     let headersDir = podsDir.appendingPathComponents(["Headers", "Public", framework])
-    if framework.hasPrefix("Firebase") {
+    if framework.hasPrefix("Firebase") && framework != "FirebaseCoreDiagnostics" {
       let frameworkHeader = headersDir.appendingPathComponent("\(framework).h")
       guard fileManager.fileExists(atPath: frameworkHeader.path) else {
         fatalError("Missing explicit umbrella header for \(framework).")

ZipBuilder/Sources/ZipBuilder/LaunchArgs.swift

@@ -41,7 +41,6 @@ struct LaunchArgs {
   private enum Key: String, CaseIterable {
     case cacheEnabled
     case customSpecRepos
-    case coreDiagnosticsDir
     case deleteCache
     case existingVersions
     case outputDir
@@ -54,8 +53,6 @@ struct LaunchArgs {
       switch self {
       case .cacheEnabled:
         return "A flag to control using the cache for frameworks."
-      case .coreDiagnosticsDir:
-        return "The path to the `CoreDiagnostics.framework` file built with the Zip flag enabled."
       case .customSpecRepos:
         return "A comma separated list of custom CocoaPod Spec repos."
       case .deleteCache:
@@ -82,9 +79,6 @@ struct LaunchArgs {
   /// verify expected version numbers.
   let allSDKsPath: URL?
 
-  /// The path to the `CoreDiagnostics.framework` file built with the Zip flag enabled.
-  let coreDiagnosticsDir: URL
-
   /// A file URL to a textproto with the contents of a `ZipBuilder_Release` object. Used to verify
   /// expected version numbers.
   let currentReleasePath: URL?
@@ -130,14 +124,6 @@ struct LaunchArgs {
 
     templateDir = URL(fileURLWithPath: templatePath)
 
-    // Parse the path to CoreDiagnostics.framework.
-    guard let diagnosticsPath = defaults.string(forKey: Key.coreDiagnosticsDir.rawValue) else {
-      LaunchArgs.exitWithUsageAndLog("Missing required key: `\(Key.coreDiagnosticsDir)` for the " +
-        "path to the CoreDiagnostics framework.")
-    }
-
-    coreDiagnosticsDir = URL(fileURLWithPath: diagnosticsPath)
-
     // Parse the existing versions key.
     if let existingVersions = defaults.string(forKey: Key.existingVersions.rawValue) {
       let url = URL(fileURLWithPath: existingVersions)

ZipBuilder/Sources/ZipBuilder/ZipBuilder.swift

@@ -65,9 +65,6 @@ struct ZipBuilder {
   struct FilesystemPaths {
     // MARK: - Required Paths
 
-    /// The path to the CoreDiagnostics.framework directory with the Zip flag enabled.
-    var coreDiagnosticsDir: URL
-
     /// The path to the directory containing the blank xcodeproj and Info.plist for building source
     /// based frameworks.
     var templateDir: URL
@@ -87,9 +84,8 @@ struct ZipBuilder {
     var logsOutputDir: URL?
 
     /// Default initializer with all required paths.
-    init(templateDir: URL, coreDiagnosticsDir: URL) {
+    init(templateDir: URL) {
       self.templateDir = templateDir
-      self.coreDiagnosticsDir = coreDiagnosticsDir
     }
   }
 
@@ -209,29 +205,6 @@ struct ZipBuilder {
       print("Frameworks for pod: \(framework) were compiled at \(paths)")
     }
 
-    // Overwrite the `FirebaseCoreDiagnostics.framework` in the `FirebaseAnalytics` folder. This is
-    // needed because it was compiled specifically with the `ZIP` bit enabled, helping us understand
-    // the distribution of CocoaPods vs Zip file integrations.
-    if podsToInstall.contains(.analytics) {
-      let overriddenAnalytics: [URL] = {
-        guard let currentFrameworks = frameworks["FirebaseAnalytics"] else {
-          fatalError("Attempted to replace CoreDiagnostics framework but the FirebaseAnalytics " +
-            "directory does not exist. Existing directories: \(frameworks.keys)")
-        }
-
-        // Filter out any CoreDiagnostics directories from the frameworks to install. There should
-        // only be one.
-        let withoutDiagnostics: [URL] = currentFrameworks.filter { url in
-          url.lastPathComponent != "FirebaseCoreDiagnostics.framework"
-        }
-
-        return withoutDiagnostics + [paths.coreDiagnosticsDir]
-      }()
-
-      // Set the newly required framework paths for Analytics.
-      frameworks["FirebaseAnalytics"] = overriddenAnalytics
-    }
-
     // Time to assemble the folder structure of the Zip file. In order to get the frameworks
     // required, we will `pod install` only those subspecs and then fetch the information for all
     // the frameworks that were installed, copying the frameworks from our list of compiled

ZipBuilder/Sources/ZipBuilder/main.swift

@@ -39,8 +39,7 @@ if args.updatePodRepo {
   cocoaPodsUpdateMessage = "CocoaPods took \(-buildStart.timeIntervalSinceNow) seconds to update."
 }
 
-var paths = ZipBuilder.FilesystemPaths(templateDir: args.templateDir,
-                                       coreDiagnosticsDir: args.coreDiagnosticsDir)
+var paths = ZipBuilder.FilesystemPaths(templateDir: args.templateDir)
 paths.allSDKsPath = args.allSDKsPath
 paths.currentReleasePath = args.currentReleasePath
 paths.logsOutputDir = args.outputDir?.appendingPathComponent("build_logs")