Merge pull request #172 from giginet/move-privacyinfo

ikesyo · web-flow · commit 1518a8f9c6b0 · 2025-01-15T17:33:08.000+09:00
Move PrivacyInfo.xcprivacy from the resource bundle to the expected location inside the framework
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -10,7 +10,9 @@ disabled_rules:
   - todo
   - cyclomatic_complexity
   - optional_data_string_conversion
-line_length: 150
+line_length:
+  warning: 150
+  ignores_comments: true
 file_length: 600
 nesting:
   type_level: 3
diff --git a/Sources/ScipioKit/Producer/PIF/FrameworkBundleAssembler.swift b/Sources/ScipioKit/Producer/PIF/FrameworkBundleAssembler.swift
@@ -29,25 +29,26 @@ struct FrameworkBundleAssembler {
     func assemble() throws -> TSCAbsolutePath {
         try fileSystem.createDirectory(frameworkBundlePath, recursive: true)
 
-        try copyInfoPlist()
-
         try copyBinary()
 
         try copyHeaders()
 
         try copyModules()
 
-        try copyResources()
+        let resourcesProcessor = ResourcesProcessor(fileSystem: fileSystem)
+        try resourcesProcessor.copyResources(
+            sourceContext: .init(
+                isFrameworkVersionedBundle: frameworkComponents.isVersionedBundle,
+                frameworkBundlePath: frameworkComponents.frameworkPath,
+                frameworkInfoPlistPath: frameworkComponents.infoPlistPath,
+                resourceBundlePath: frameworkComponents.resourceBundlePath
+            ),
+            destinationFrameworkBundlePath: frameworkBundlePath
+        )
 
         return frameworkBundlePath
     }
 
-    private func copyInfoPlist() throws {
-        let sourcePath = frameworkComponents.infoPlistPath
-        let destinationPath = frameworkBundlePath.appending(component: "Info.plist")
-        try fileSystem.copy(from: sourcePath, to: destinationPath)
-    }
-
     private func copyBinary() throws {
         let sourcePath = frameworkComponents.binaryPath
         let destinationPath = frameworkBundlePath.appending(component: frameworkComponents.frameworkName)
@@ -153,11 +154,101 @@ struct FrameworkBundleAssembler {
             )
         }
     }
+}
+
+extension FrameworkBundleAssembler {
+    struct ResourcesProcessor {
+        struct SourceContext {
+            let isFrameworkVersionedBundle: Bool
+            let frameworkBundlePath: TSCAbsolutePath
+            let frameworkInfoPlistPath: TSCAbsolutePath
+            let resourceBundlePath: TSCAbsolutePath?
+        }
+
+        private let fileSystem: any FileSystem
+
+        init(fileSystem: some FileSystem) {
+            self.fileSystem = fileSystem
+        }
+
+        func copyResources(
+            sourceContext: SourceContext,
+            destinationFrameworkBundlePath: TSCAbsolutePath
+        ) throws {
+            if sourceContext.isFrameworkVersionedBundle {
+                // The framework is a versioned bundle, so copy entire Resources directory
+                // instead of copying its Info.plist and resource bundle separately.
+                let sourceResourcesPath = sourceContext.frameworkBundlePath.appending(component: "Resources")
+                let destinationResourcesPath = destinationFrameworkBundlePath.appending(component: "Resources")
+                try fileSystem.copy(
+                    from: sourceResourcesPath.asURL.resolvingSymlinksInPath().absolutePath,
+                    to: destinationResourcesPath
+                )
+
+                if let resourceBundleName = sourceContext.resourceBundlePath?.basename {
+                    let resourceBundlePath = destinationResourcesPath.appending(component: resourceBundleName)
+                    // A resource bundle of versioned bundle framework has "Contents/Resources" directory.
+                    try extractPrivacyInfoIfExists(
+                        from: TSCRelativePath(validating: "Contents/Resources/PrivacyInfo.xcprivacy"),
+                        in: resourceBundlePath
+                    )
+                }
+            } else {
+                try copyInfoPlist(
+                    sourceContext: sourceContext,
+                    destinationFrameworkBundlePath: destinationFrameworkBundlePath
+                )
+                let copiedResourceBundlePath = try copyResourceBundle(
+                    sourceContext: sourceContext,
+                    destinationFrameworkBundlePath: destinationFrameworkBundlePath
+                )
+
+                if let copiedResourceBundlePath {
+                    try extractPrivacyInfoIfExists(
+                        from: TSCRelativePath(validating: "PrivacyInfo.xcprivacy"),
+                        in: copiedResourceBundlePath
+                    )
+                }
+            }
+        }
+
+        private func copyInfoPlist(
+            sourceContext: SourceContext,
+            destinationFrameworkBundlePath: TSCAbsolutePath
+        ) throws {
+            let sourcePath = sourceContext.frameworkInfoPlistPath
+            let destinationPath = destinationFrameworkBundlePath.appending(component: "Info.plist")
+            try fileSystem.copy(from: sourcePath, to: destinationPath)
+        }
 
-    private func copyResources() throws {
-        if let resourceBundlePath = frameworkComponents.resourceBundlePath {
-            let destinationPath = frameworkBundlePath.appending(component: resourceBundlePath.basename)
-            try fileSystem.copy(from: resourceBundlePath, to: destinationPath)
+        /// Returns the resulting, copied resource bundle path.
+        private func copyResourceBundle(
+            sourceContext: SourceContext,
+            destinationFrameworkBundlePath: TSCAbsolutePath
+        ) throws -> TSCAbsolutePath? {
+            if let sourcePath = sourceContext.resourceBundlePath {
+                let destinationPath = destinationFrameworkBundlePath.appending(component: sourcePath.basename)
+                try fileSystem.copy(from: sourcePath, to: destinationPath)
+                return destinationPath
+            } else {
+                return nil
+            }
+        }
+
+        /// Extracts PrivacyInfo.xcprivacy to expected location (if exists in the resource bundle).
+        ///
+        /// - seealso: https://developer.apple.com/documentation/bundleresources/adding-a-privacy-manifest-to-your-app-or-third-party-sdk#Add-a-privacy-manifest-to-your-framework
+        private func extractPrivacyInfoIfExists(
+            from relativePrivacyInfoPath: TSCRelativePath,
+            in resourceBundlePath: TSCAbsolutePath
+        ) throws {
+            let privacyInfoPath = resourceBundlePath.appending(relativePrivacyInfoPath)
+            if fileSystem.exists(privacyInfoPath) {
+                try fileSystem.move(
+                    from: privacyInfoPath,
+                    to: resourceBundlePath.parentDirectory.appending(component: relativePrivacyInfoPath.basename)
+                )
+            }
         }
     }
 }
diff --git a/Sources/ScipioKit/Producer/PIF/FrameworkComponentsCollector.swift b/Sources/ScipioKit/Producer/PIF/FrameworkComponentsCollector.swift
@@ -4,7 +4,14 @@ import PackageModel
 
 /// FileLists to assemble a framework bundle
 struct FrameworkComponents {
+    /// Whether the built framework is a versioned bundle or not.
+    ///
+    /// In general, frameworks for macOS would be this format.
+    ///
+    /// - seealso: https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPFrameworks/Concepts/FrameworkAnatomy.html
+    var isVersionedBundle: Bool
     var frameworkName: String
+    var frameworkPath: TSCAbsolutePath
     var binaryPath: TSCAbsolutePath
     var infoPlistPath: TSCAbsolutePath
     var swiftModulesPath: TSCAbsolutePath?
@@ -34,6 +41,8 @@ struct FrameworkComponentsCollector {
     private let packageLocator: any PackageLocator
     private let fileSystem: any FileSystem
 
+    private let productsDirectory: TSCAbsolutePath
+
     init(
         buildProduct: BuildProduct,
         sdk: SDK,
@@ -46,6 +55,11 @@ struct FrameworkComponentsCollector {
         self.buildOptions = buildOptions
         self.packageLocator = packageLocator
         self.fileSystem = fileSystem
+
+        productsDirectory = packageLocator.productsDirectory(
+            buildConfiguration: buildOptions.buildConfiguration,
+            sdk: sdk
+        )
     }
 
     func collectComponents(sdk: SDK) throws -> FrameworkComponents {
@@ -60,6 +74,11 @@ struct FrameworkComponentsCollector {
         let targetName = buildProduct.target.c99name
         let generatedFrameworkPath = generatedFrameworkPath()
 
+        let isVersionedBundle = fileSystem.exists(
+            generatedFrameworkPath.appending(component: "Resources"),
+            followSymlink: true
+        )
+
         let binaryPath = generatedFrameworkPath.appending(component: targetName)
 
         let swiftModulesPath = try collectSwiftModules(
@@ -74,15 +93,17 @@ struct FrameworkComponentsCollector {
 
         let publicHeaders = try collectPublicHeaders()
 
-        let resourceBundlePath = try collectResourceBundle(
-            of: targetName,
-            in: generatedFrameworkPath
-        )
+        let resourceBundlePath = generatedResourceBundlePath()
 
-        let infoPlistPath = try collectInfoPlist(in: generatedFrameworkPath)
+        let infoPlistPath = try collectInfoPlist(
+            in: generatedFrameworkPath,
+            isVersionedBundle: isVersionedBundle
+        )
 
         let components = FrameworkComponents(
+            isVersionedBundle: isVersionedBundle,
             frameworkName: buildProduct.target.name.packageNamed(),
+            frameworkPath: generatedFrameworkPath,
             binaryPath: binaryPath,
             infoPlistPath: infoPlistPath,
             swiftModulesPath: swiftModulesPath,
@@ -121,24 +142,33 @@ struct FrameworkComponentsCollector {
     }
 
     private func generatedFrameworkPath() -> TSCAbsolutePath {
-        packageLocator.productsDirectory(
-            buildConfiguration: buildOptions.buildConfiguration,
-            sdk: sdk
-        )
-        .appending(component: "\(buildProduct.target.c99name).framework")
+        productsDirectory.appending(component: "\(buildProduct.target.c99name).framework")
     }
 
-    private func collectInfoPlist(in frameworkBundlePath: TSCAbsolutePath) throws -> TSCAbsolutePath {
-        let infoPlistLocationCandidates = [
-            // In a regular framework bundle, Info.plist should be on its root
-            frameworkBundlePath.appending(component: "Info.plist"),
+    private func generatedResourceBundlePath() -> TSCAbsolutePath? {
+        guard let bundleName = buildProduct.target.underlying.bundleName else { return nil }
+
+        let path = productsDirectory.appending(component: "\(bundleName).bundle")
+        return fileSystem.exists(path) ? path : nil
+    }
+
+    private func collectInfoPlist(
+        in frameworkBundlePath: TSCAbsolutePath,
+        isVersionedBundle: Bool
+    ) throws -> TSCAbsolutePath {
+        let infoPlistLocation = if isVersionedBundle {
             // In a versioned framework bundle (for macOS), Info.plist should be in Resources
-            frameworkBundlePath.appending(components: "Resources", "Info.plist"),
-        ]
-        guard let infoPlistPath = infoPlistLocationCandidates.first(where: fileSystem.exists(_:)) else {
+            frameworkBundlePath.appending(components: "Resources", "Info.plist")
+        } else {
+            // In a regular framework bundle, Info.plist should be on its root
+            frameworkBundlePath.appending(component: "Info.plist")
+        }
+
+        if fileSystem.exists(infoPlistLocation) {
+            return infoPlistLocation
+        } else {
             throw Error.infoPlistNotFound(frameworkBundlePath: frameworkBundlePath)
         }
-        return infoPlistPath
     }
 
     /// Collects *.swiftmodules* in a generated framework bundle
@@ -193,9 +223,4 @@ struct FrameworkComponentsCollector {
 
         return Set(notSymlinks + notDuplicatedSymlinks)
     }
-
-    private func collectResourceBundle(of targetName: String, in frameworkPath: TSCAbsolutePath) throws -> TSCAbsolutePath? {
-        let bundleFileName = try fileSystem.getDirectoryContents(frameworkPath).first { $0.hasSuffix(".bundle") }
-        return bundleFileName.flatMap { frameworkPath.appending(component: $0) }
-    }
 }
diff --git a/Tests/ScipioKitTests/FrameworkBundleAssemblerTests.swift b/Tests/ScipioKitTests/FrameworkBundleAssemblerTests.swift
@@ -45,7 +45,9 @@ struct FrameworkBundleAssemblerTests {
     private func assembleFramework(keepPublicHeadersStructure: Bool, outputDirectory: TSCAbsolutePath) throws {
         let fixture = fixturesPath.appendingPathComponent("FrameworkBundleAssemblerTests").absolutePath
         let frameworkComponents = FrameworkComponents(
+            isVersionedBundle: false,
             frameworkName: "Foo",
+            frameworkPath: fixture.appending(component: "Foo.framework"),
             binaryPath: fixture.appending(components: "Foo.framework", "Foo"),
             infoPlistPath: fixture.appending(components: "Foo.framework", "Info.plist"),
             includeDir: fixture.appending(components: "include"),
diff --git a/Tests/ScipioKitTests/Resources/Fixtures/ResourcePackage/Package.swift b/Tests/ScipioKitTests/Resources/Fixtures/ResourcePackage/Package.swift
@@ -21,6 +21,7 @@ let package = Package(
             dependencies: [
             ],
             resources: [
+                .copy("Resources/PrivacyInfo.xcprivacy"),
                 .process("Resources/giginet.png"),
             ]
         )
diff --git a/Tests/ScipioKitTests/Resources/Fixtures/ResourcePackage/Sources/ResourcePackage/Resources/PrivacyInfo.xcprivacy b/Tests/ScipioKitTests/Resources/Fixtures/ResourcePackage/Sources/ResourcePackage/Resources/PrivacyInfo.xcprivacy
@@ -0,0 +1,12 @@
+<?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>NSPrivacyAccessedAPITypes</key>
+	<array>
+	</array>
+	<key>NSPrivacyCollectedDataTypes</key>
+	<array>
+	</array>
+</dict>
+</plist>
diff --git a/Tests/ScipioKitTests/RunnerTests.swift b/Tests/ScipioKitTests/RunnerTests.swift
@@ -621,9 +621,15 @@ final class RunnerTests: XCTestCase {
 
         let xcFramework = frameworkOutputDir.appendingPathComponent("ResourcePackage.xcframework")
         for arch in ["ios-arm64", "ios-arm64_x86_64-simulator"] {
-            let bundlePath = xcFramework
+            let frameworkPath = xcFramework
                 .appendingPathComponent(arch)
                 .appendingPathComponent("ResourcePackage.framework")
+            XCTAssertTrue(
+                fileManager.fileExists(atPath: frameworkPath.appendingPathComponent("PrivacyInfo.xcprivacy").path),
+                "PrivacyInfo.xcprivacy should be located at the expected location"
+            )
+
+            let bundlePath = frameworkPath
                 .appendingPathComponent("ResourcePackage_ResourcePackage.bundle")
             XCTAssertTrue(
                 fileManager.fileExists(atPath: bundlePath.path),

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ let package = Package(`
`21`	`21`	`dependencies: [`
`22`	`22`	`],`
`23`	`23`	`resources: [`
	`24`	`+ .copy("Resources/PrivacyInfo.xcprivacy"),`
`24`	`25`	`.process("Resources/giginet.png"),`
`25`	`26`	`]`
`26`	`27`	`)`