Zip Resource handling for xcframeworks (#5093)

paulb777 · paulb777 · commit bbbcb4979573 · 2020-03-13T11:11:29.000-07:00
diff --git a/ZipBuilder/Sources/ZipBuilder/CarthageUtils.swift b/ZipBuilder/Sources/ZipBuilder/CarthageUtils.swift
@@ -109,24 +109,6 @@ extension CarthageUtils {
         }
       }
 
-      // Make updates to all frameworks to make Carthage happy. We don't worry about xcframeworks
-      // here.
-      let allFileObjects = FileManager.default.enumerator(atPath: fullPath.path)?.allObjects
-      guard let allFiles = allFileObjects as? [String] else {
-        fatalError("Failed to get file list for Carthage construction at \(fullPath.path)")
-      }
-      let frameworks = allFiles.filter { $0.hasSuffix(".framework") }
-      for framework in frameworks {
-        let plistPath = fullPath.appendingPathComponents([framework, "Info.plist"])
-        // Drop the extension of the framework name.
-        let plist = generatePlistContents(forName: framework.components(separatedBy: ".").first!)
-        do {
-          try plist.write(to: plistPath)
-        } catch {
-          fatalError("Could not copy plist for \(framework) for Carthage release. \(error)")
-        }
-      }
-
       // Analytics includes all the Core frameworks and Firebase module, do extra work to package
       // it.
       if product == "FirebaseAnalytics" {
@@ -266,7 +248,7 @@ extension CarthageUtils {
     }
   }
 
-  private static func generatePlistContents(forName name: String) -> Data {
+  static func generatePlistContents(forName name: String) -> Data {
     let plist: [String: String] = ["CFBundleIdentifier": "com.firebase.Firebase",
                                    "CFBundleInfoDictionaryVersion": "6.0",
                                    "CFBundlePackageType": "FMWK",
diff --git a/ZipBuilder/Sources/ZipBuilder/FrameworkBuilder.swift b/ZipBuilder/Sources/ZipBuilder/FrameworkBuilder.swift
@@ -509,18 +509,13 @@ struct FrameworkBuilder {
 
     // Move all the Resources into .bundle directories in the destination Resources dir. The
     // Resources live are contained within the folder structure:
-    // `projectDir/arch/Release-platform/FrameworkName`
+    // `projectDir/arch/Release-platform/FrameworkName`.
+    // The Resources are stored at the top-level of the .framework or .xcframework directory.
+    // For Firebase distributions, they are propagated one level higher in the final distribution.
 
-    let contentsDir = projectDir.appendingPathComponents([anyArch.rawValue,
-                                                          "Release-\(anyArch.platform.rawValue)",
-                                                          framework])
-    let resourceDir = frameworkDir.appendingPathComponent("Resources")
-    do {
-      try ResourcesManager.moveAllBundles(inDirectory: contentsDir, to: resourceDir)
-    } catch {
-      fatalError("Could not move bundles into Resources directory while building \(framework): " +
-        "\(error)")
-    }
+    let resourceContents = projectDir.appendingPathComponents([anyArch.rawValue,
+                                                               "Release-\(anyArch.platform.rawValue)",
+                                                               framework])
 
     guard let moduleMapContentsTemplate = podInfo.moduleMapContents else {
       fatalError("Module map contents missing for framework \(framework)")
@@ -529,6 +524,7 @@ struct FrameworkBuilder {
     let xcframework = packageXCFramework(withName: framework,
                                          fromFolder: frameworkDir,
                                          thinArchives: thinArchives,
+                                         resourceContents: resourceContents,
                                          moduleMapContents: moduleMapContents)
 
     var carthageFramework: URL?
@@ -545,6 +541,7 @@ struct FrameworkBuilder {
       carthageFramework = packageCarthageFramework(withName: framework,
                                                    fromFolder: frameworkDir,
                                                    thinArchives: carthageThinArchives,
+                                                   resourceContents: resourceContents,
                                                    moduleMapContents: moduleMapContents)
     }
     // Remove the temporary thin archives.
@@ -697,10 +694,12 @@ struct FrameworkBuilder {
   /// - Parameter withName: The framework name.
   /// - Parameter fromFolder: The almost complete framework folder. Includes everything but the binary.
   /// - Parameter thinArchives: All the thin archives.
+  /// - Parameter resourceContents: Location of the resources for this xcframework.
   /// - Parameter moduleMapContents: Module map contents for all frameworks in this pod.
   private func packageXCFramework(withName framework: String,
                                   fromFolder: URL,
                                   thinArchives: [Architecture: URL],
+                                  resourceContents: URL,
                                   moduleMapContents: String) -> URL {
     let fileManager = FileManager.default
 
@@ -784,6 +783,17 @@ struct FrameworkBuilder {
     case .success:
       print("XCFramework for \(framework) built successfully at \(xcframework).")
     }
+    // xcframework resources are packaged at top of xcframework. We do a copy instead of a move
+    // because the resources may also be copied for the Carthage distribution.
+    let resourceDir = xcframework.appendingPathComponent("Resources")
+    do {
+      try ResourcesManager.moveAllBundles(inDirectory: resourceContents,
+                                          to: resourceDir,
+                                          keepOriginal: true)
+    } catch {
+      fatalError("Could not move bundles into Resources directory while building \(framework): " +
+        "\(error)")
+    }
 
     return xcframework
   }
@@ -792,10 +802,12 @@ struct FrameworkBuilder {
   /// - Parameter withName: The framework name.
   /// - Parameter fromFolder: The almost complete framework folder. Includes everything but the binary.
   /// - Parameter thinArchives: All the thin archives.
+  /// - Parameter resourceContents: Location of the resources for this Carthage framework.
   /// - Parameter moduleMapContents: Module map contents for all frameworks in this pod.
   private func packageCarthageFramework(withName framework: String,
                                         fromFolder: URL,
                                         thinArchives: [Architecture: URL],
+                                        resourceContents: URL,
                                         moduleMapContents: String) -> URL {
     let fileManager = FileManager.default
 
@@ -814,12 +826,31 @@ struct FrameworkBuilder {
     let slices = thinArchives.filter { $0.key != Architecture.x86_64h }
 
     // Package a normal .framework with the given slices.
-    let destination = platformFrameworksDir.appendingPathComponent(fromFolder.lastPathComponent)
+    let frameworkDir = platformFrameworksDir.appendingPathComponent(fromFolder.lastPathComponent)
     packageFramework(withName: framework,
                      fromFolder: fromFolder,
                      thinArchives: slices,
-                     destination: destination,
+                     destination: frameworkDir,
                      moduleMapContents: moduleMapContents)
-    return destination
+
+    // Add Info.plist frameworks to make Carthage happy.
+    let plistPath = frameworkDir.appendingPathComponents(["Info.plist"])
+    // Drop the extension of the framework name.
+    let plist = CarthageUtils.generatePlistContents(forName: framework)
+    do {
+      try plist.write(to: plistPath)
+    } catch {
+      fatalError("Could not copy plist for \(frameworkDir) for Carthage release. \(error)")
+    }
+
+    // Carthage Resources are packaged in the framework.
+    let resourceDir = frameworkDir.appendingPathComponent("Resources")
+    do {
+      try ResourcesManager.moveAllBundles(inDirectory: resourceContents, to: resourceDir)
+    } catch {
+      fatalError("Could not move bundles into Resources directory while building \(framework): " +
+        "\(error)")
+    }
+    return frameworkDir
   }
 }
diff --git a/ZipBuilder/Sources/ZipBuilder/ResourcesManager.swift b/ZipBuilder/Sources/ZipBuilder/ResourcesManager.swift
@@ -159,10 +159,13 @@ extension ResourcesManager {
   ///   - dir: The directory to search for Resource bundles.
   ///   - resourceDir: The destination Resources directory. This function will create the Resources
   ///                  directory if it doesn't exist.
+  ///   - keepOriginal: Do a copy instead of a move.
   /// - Returns: An array of URLs pointing to the newly located bundles.
   /// - Throws: Any file system errors that occur.
   @discardableResult
-  static func moveAllBundles(inDirectory dir: URL, to resourceDir: URL) throws -> [URL] {
+  static func moveAllBundles(inDirectory dir: URL,
+                             to resourceDir: URL,
+                             keepOriginal: Bool = false) throws -> [URL] {
     let fileManager = FileManager.default
     let allBundles = try fileManager.recursivelySearch(for: .bundles, in: dir)
 
@@ -171,7 +174,7 @@ extension ResourcesManager {
     guard !allBundles.isEmpty else { return [] }
 
     // Move the found bundles into the Resources directory.
-    let bundlesMoved = try moveAllFiles(allBundles, toDir: resourceDir)
+    let bundlesMoved = try moveAllFiles(allBundles, toDir: resourceDir, keepOriginal: keepOriginal)
 
     // Remove any empty Resources directories left over as part of the move.
     removeEmptyResourcesDirectories(in: dir)
@@ -290,9 +293,11 @@ extension ResourcesManager {
   ///   - files: URLs to files to move.
   ///   - destinationDir: Destination directory to move all the files. Creates the directory if it
   ///                     doesn't exist.
+  ///   - keepOriginal: Do a copy instead of a move.
   /// - Throws: Any file system errors that occur.
   @discardableResult
-  private static func moveAllFiles(_ files: [URL], toDir destinationDir: URL) throws -> [URL] {
+  private static func moveAllFiles(_ files: [URL], toDir destinationDir: URL,
+                                   keepOriginal: Bool = false) throws -> [URL] {
     let fileManager = FileManager.default
     if !fileManager.directoryExists(at: destinationDir) {
       try fileManager.createDirectory(at: destinationDir, withIntermediateDirectories: true)
@@ -303,7 +308,11 @@ extension ResourcesManager {
       // Create the destination URL by using the filename of the file but prefix of the
       // destinationDir.
       let destination = destinationDir.appendingPathComponent(file.lastPathComponent)
-      try fileManager.moveItem(at: file, to: destination)
+      if keepOriginal {
+        try fileManager.copyItem(at: file, to: destination)
+      } else {
+        try fileManager.moveItem(at: file, to: destination)
+      }
       filesMoved.append(destination)
     }
 
diff --git a/ZipBuilder/Sources/ZipBuilder/ZipBuilder.swift b/ZipBuilder/Sources/ZipBuilder/ZipBuilder.swift
@@ -658,16 +658,12 @@ struct ZipBuilder {
     // Create the temporary directory we'll be storing the build/assembled frameworks in, and remove
     // the Resources directory if it already exists.
     let tempDir = fileManager.temporaryDirectory(withName: "all_frameworks")
-    let tempResourceDir = tempDir.appendingPathComponent("Resources")
     do {
       try fileManager.createDirectory(at: tempDir,
                                       withIntermediateDirectories: true,
                                       attributes: nil)
-      if fileManager.directoryExists(at: tempResourceDir) {
-        try fileManager.removeItem(at: tempResourceDir)
-      }
     } catch {
-      fatalError("Cannot create temporary directory to store frameworks and resources from the " +
+      fatalError("Cannot create temporary directory to store frameworks from the " +
         "full build: \(error)")
     }
 
