Move to xcframework bundles #4737
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ enum Architecture: String, CaseIterable { | |
| enum TargetPlatform: String { | ||
| case device = "iphoneos" | ||
| case simulator = "iphonesimulator" | ||
| case catalyst = "macosx" | ||
|
|
||
| /// Extra C flags that should be included as part of the build process for each target platform. | ||
| func otherCFlags() -> [String] { | ||
|
|
@@ -32,21 +33,24 @@ enum Architecture: String, CaseIterable { | |
| case .simulator: | ||
| // No extra arguments are required for simulator builds. | ||
| return [] | ||
| case .catalyst: | ||
| return [] | ||
| } | ||
| } | ||
| } | ||
|
|
||
| case arm64 | ||
| case armv7 | ||
| case i386 | ||
| case x86_64 | ||
| case x86_64h // x86_64h, Haswell, used for Mac Catalyst | ||
|
|
||
| /// The platform associated with the architecture. | ||
| var platform: TargetPlatform { | ||
| switch self { | ||
| case .armv7, .arm64: return .device | ||
| case .i386, .x86_64: return .simulator | ||
| case .x86_64h: return .catalyst | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -96,7 +100,8 @@ struct FrameworkBuilder { | |
| } | ||
|
|
||
| // Build the full cached framework path. | ||
| let realFramework = realFrameworkName(podName) | ||
| let cachedFrameworkDir = cachedFrameworkRoot.appendingPathComponent("\(realFramework).framework") | ||
| let frameworkDir = compileFrameworkAndResources(withName: podName) | ||
| do { | ||
| // Remove the previously cached framework if it exists, otherwise the `moveItem` call will | ||
|
|
@@ -181,20 +186,31 @@ struct FrameworkBuilder { | |
| /// - logRoot: Root directory where all logs should be written. | ||
| /// - Returns: A URL to the thin library that was built. | ||
| private func buildThin(framework: String, | ||
| archs: [Architecture], | ||
| buildDir: URL, | ||
| logRoot: URL) -> URL { | ||
|
|
||
| let arch = archs[0] | ||
| let isMacCatalyst = arch == Architecture.x86_64h | ||
| let isMacCatalystString = isMacCatalyst ? "YES" : "NO" | ||
| let platform = arch.platform | ||
| let platformFolder = isMacCatalyst ? "maccatalyst" : platform.rawValue | ||
| let workspacePath = projectDir.appendingPathComponent("FrameworkMaker.xcworkspace").path | ||
| let distributionFlag = carthageBuild ? "-DFIREBASE_BUILD_CARTHAGE" : "-DFIREBASE_BUILD_ZIP_FILE" | ||
| let platformSpecificFlags = platform.otherCFlags().joined(separator: " ") | ||
| let cFlags = "OTHER_CFLAGS=$(value) \(distributionFlag) \(platformSpecificFlags)" | ||
| let cleanArch = isMacCatalyst ? Architecture.x86_64.rawValue : archs.map{$0.rawValue}.joined(separator: " ") | ||
|
|
||
| let args = ["build", | ||
| "-configuration", "release", | ||
| "-workspace", workspacePath, | ||
| "-scheme", framework, | ||
| "GCC_GENERATE_DEBUGGING_SYMBOLS=No", | ||
| "ARCHS=\(cleanArch)", | ||
| "VALID_ARCHS=\(cleanArch)", | ||
| "ONLY_ACTIVE_ARCH=NO", | ||
| "BUILD_LIBRARIES_FOR_DISTRIBUTION=YES", | ||
| "SUPPORTS_MACCATALYST=\(isMacCatalystString)", | ||
| "BUILD_DIR=\(buildDir.path)", | ||
| "-sdk", platform.rawValue, | ||
| cFlags] | ||
|
|
@@ -227,15 +243,30 @@ struct FrameworkBuilder { | |
| """) | ||
|
|
||
| // Use the Xcode-generated path to return the path to the compiled library. | ||
| let realFramework = realFrameworkName(framework) | ||
| let libPath = buildDir.appendingPathComponents(["Release-\(platformFolder)", | ||
| framework, | ||
| "\(realFramework).framework"]) | ||
|
|
||
| print("buildThin returns \(libPath)") | ||
| return libPath | ||
| } | ||
| } | ||
|
|
||
| // Cries in Google. Why is this not the same? | ||
|
There was a problem hiding this comment. This is likely because of CocoaPods |
||
| private func realFrameworkName(_ framework: String) -> String { | ||
| switch framework { | ||
| case "PromisesObjC": | ||
| return "FBLPromises" | ||
| case "Protobuf": | ||
| return "protobuf" | ||
| default: | ||
| return framework | ||
| } | ||
| } | ||
|
|
||
| /// Compiles the specified framework in a temporary directory and writes the build logs to file. | ||
| /// This will compile all architectures and use the -create-xcframework command to create a modern "fat" framework. | ||
| /// | ||
| /// - Parameter framework: The name of the framework to be built. | ||
| /// - Parameter logsOutputDir: The path to the directory to place build logs. | ||
|
|
@@ -264,88 +295,52 @@ struct FrameworkBuilder { | |
| // Build every architecture and save the locations in an array to be assembled. | ||
| // TODO: Pass in supported architectures here, for those open source SDKs that don't support | ||
| // individual architectures. | ||
| // | ||
| // xcframework doesn't lipo things together but accepts fat frameworks for one target. | ||
| // We group architectures here to deal with this fact. | ||
| var archs = LaunchArgs.shared.archs | ||
| var groupedArchs: [[Architecture]] = [] | ||
|
|
||
| for pair in [[Architecture.armv7, .arm64], [Architecture.i386, .x86_64]] { | ||
| if archs.contains(pair[0]) && archs.contains(pair[1]) { | ||
| groupedArchs.append(pair) | ||
| archs = archs.filter() { !pair.contains($0) } | ||
| } | ||
| } | ||
| // Add remaining ungrouped | ||
| for arch in archs { | ||
| groupedArchs.append([arch]) | ||
| } | ||
|
|
||
| var thinArchives = [URL]() | ||
| for archs in groupedArchs { | ||
| let buildDir = projectDir.appendingPathComponent(archs[0].rawValue) | ||
| let thinArchive = buildThin(framework: framework, | ||
| archs: archs, | ||
| buildDir: buildDir, | ||
| logRoot: logsDir) | ||
| thinArchives.append(thinArchive) | ||
| } | ||
|
|
||
| let frameworkDir = outputDir.appendingPathComponent("\(framework).xcframework") | ||
|
|
||
| let inputArgs = thinArchives.flatMap { url -> [String] in | ||
| return ["-framework", url.path] | ||
| } | ||
|
|
||
| print("About to create xcframework for \(frameworkDir.path) with \(inputArgs)") | ||
|
|
||
| // xcframework doesn't support legacy architectures: armv7, i386. | ||
steipete marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // It will throw a "Both ios-arm64 and ios-armv7 represent two equivalent library definitions" error. | ||
| let result = syncExec(command: "/usr/bin/xcodebuild", args: ["-create-xcframework", "-output", frameworkDir.path] + inputArgs) | ||
| switch result { | ||
| case let .error(code, output): | ||
| fatalError(""" | ||
| xcodebuild -create-xcframework command exited with \(code) when trying to build \(framework). Output: | ||
| \(output) | ||
| """) | ||
| case .success: | ||
| print("xcodebuild -create-xcframework command for \(framework) succeeded.") | ||
| } | ||
|
|
||
| return frameworkDir | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>com.apple.security.app-sandbox</key> | ||
| <true/> | ||
| <key>com.apple.security.network.client</key> | ||
| <true/> | ||
| </dict> | ||
| </plist> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use_frameworks!was purposely not there to build static library frameworks.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems there's a way for xcframework containers to take either, but I didn't get it to work, since that container then expects just a static binar and not a fake framework with header constructs. With dyld3 being there on iOS 13 that shouldn't be a huge impact, and we can delete quite a bit of the script logic.
Folks with CocoaPods can still choose either.