Fix building frameworks (#9259)

daveinglis · web-flow · commit e907a5bbb124 · 2025-10-20T14:31:51.000-04:00
- fix pif target product name for frameworks
- add new experimental flag to swift build that will build dylibs as
frameworks so we can have a tests that ensure we don't regress.
diff --git a/Fixtures/Miscellaneous/DynamicProduct/exec/Package.swift b/Fixtures/Miscellaneous/DynamicProduct/exec/Package.swift
@@ -0,0 +1,18 @@
+// swift-tools-version:6.0
+
+import PackageDescription
+
+let package = Package(
+    name: "exec",
+    dependencies: [
+        .package(path: "../secondDyna")
+    ],
+    targets: [
+        .executableTarget(
+            name: "exec",
+            dependencies: ["secondDyna"]),
+        .testTarget(
+            name: "DynaTests",
+            dependencies: ["exec"])
+    ]
+)
diff --git a/Fixtures/Miscellaneous/DynamicProduct/exec/README.md b/Fixtures/Miscellaneous/DynamicProduct/exec/README.md
@@ -0,0 +1,3 @@
+# exec
+
+A description of this package.
diff --git a/Fixtures/Miscellaneous/DynamicProduct/exec/Sources/exec/main.swift b/Fixtures/Miscellaneous/DynamicProduct/exec/Sources/exec/main.swift
@@ -0,0 +1,3 @@
+import secondDyna
+
+print(secondDyna.hello())
diff --git a/Fixtures/Miscellaneous/DynamicProduct/exec/Tests/DynaTests/Tests.swift b/Fixtures/Miscellaneous/DynamicProduct/exec/Tests/DynaTests/Tests.swift
@@ -0,0 +1 @@
+error
diff --git a/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Package.swift b/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Package.swift
@@ -0,0 +1,21 @@
+// swift-tools-version:5.0
+
+import PackageDescription
+
+let package = Package(
+    name: "firstDyna",
+    products: [
+        .library(
+            name: "firstDyna",
+            type: .dynamic,
+            targets: ["firstDyna"])
+    ],
+    targets: [
+        .target(
+            name: "firstDyna",
+            dependencies: ["Core"]),
+        .target(
+            name: "Core",
+            dependencies: [])
+    ]
+)
diff --git a/Fixtures/Miscellaneous/DynamicProduct/firstDyna/README.md b/Fixtures/Miscellaneous/DynamicProduct/firstDyna/README.md
@@ -0,0 +1,3 @@
+# firstDyna
+
+A description of this package.
diff --git a/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/Core/Core.c b/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/Core/Core.c
@@ -0,0 +1,5 @@
+#include<Core.h>
+
+char* hello() {
+    return "Hello";
+}
diff --git a/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/Core/include/Core.h b/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/Core/include/Core.h
@@ -0,0 +1,2 @@
+
+char* hello();
diff --git a/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/firstDyna/firstDyna.swift b/Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/firstDyna/firstDyna.swift
@@ -0,0 +1,5 @@
+import Core
+
+public func hello() -> String {
+    return String(cString: Core.hello())
+}
diff --git a/Fixtures/Miscellaneous/DynamicProduct/secondDyna/Package.swift b/Fixtures/Miscellaneous/DynamicProduct/secondDyna/Package.swift
@@ -0,0 +1,21 @@
+// swift-tools-version:5.0
+
+import PackageDescription
+
+let package = Package(
+    name: "secondDyna",
+    products: [
+        .library(
+            name: "secondDyna",
+            type: .dynamic,
+            targets: ["secondDyna"])
+    ],
+    dependencies: [
+        .package(path: "../firstDyna")
+    ],
+    targets: [
+        .target(
+            name: "secondDyna",
+            dependencies: ["firstDyna"])
+    ]
+)
diff --git a/Fixtures/Miscellaneous/DynamicProduct/secondDyna/README.md b/Fixtures/Miscellaneous/DynamicProduct/secondDyna/README.md
@@ -0,0 +1,3 @@
+# secondDyna
+
+A description of this package.
diff --git a/Fixtures/Miscellaneous/DynamicProduct/secondDyna/Sources/secondDyna/secondDyna.swift b/Fixtures/Miscellaneous/DynamicProduct/secondDyna/Sources/secondDyna/secondDyna.swift
@@ -0,0 +1,5 @@
+import firstDyna 
+
+public func hello() -> String {
+    return firstDyna.hello()
+}
diff --git a/Sources/CoreCommands/Options.swift b/Sources/CoreCommands/Options.swift
@@ -579,6 +579,10 @@ public struct BuildOptions: ParsableArguments {
     @Flag(inversion: .prefixedNo, help: .hidden)
     public var omitFramePointers: Bool? = nil
 
+    // Build dynamic library targets as frameworks (only available for Darwin targets and only when using the 'swiftbuild' build-system (currently used for tests).
+    @Flag(name: .customLong("experimental-build-dylibs-as-frameworks"), help: .hidden )
+    public var shouldBuildDylibsAsFrameworks: Bool = false
+
     // @Flag works best when there is a default value present
     // if true, false aren't enough and a third state is needed
     // nil should not be the goto. Instead create an enum
diff --git a/Sources/CoreCommands/SwiftCommandState.swift b/Sources/CoreCommands/SwiftCommandState.swift
@@ -916,6 +916,7 @@ public final class SwiftCommandState {
             pkgConfigDirectories: options.locations.pkgConfigDirectories,
             architectures: options.build.architectures,
             workers: options.build.jobs ?? UInt32(ProcessInfo.processInfo.activeProcessorCount),
+            shouldCreateDylibForDynamicProducts: !self.options.build.shouldBuildDylibsAsFrameworks,
             sanitizers: options.build.enabledSanitizers,
             indexStoreMode: options.build.indexStoreMode.buildParameter,
             prepareForIndexing: prepareForIndexingMode,
diff --git a/Sources/SwiftBuildSupport/PackagePIFProjectBuilder+Products.swift b/Sources/SwiftBuildSupport/PackagePIFProjectBuilder+Products.swift
@@ -588,11 +588,12 @@ extension PackagePIFProjectBuilder {
         // FIXME: Cleanup this mess with <rdar://56889224>
 
         let productType: ProjectModel.Target.ProductType
-
+        var productName = "$(EXECUTABLE_NAME)"
         if desiredProductType == .dynamic {
             if pifBuilder.createDylibForDynamicProducts {
                 productType = .dynamicLibrary
             } else {
+                productName = "$(WRAPPER_NAME)"
                 productType = .framework
             }
         } else {
@@ -608,7 +609,7 @@ extension PackagePIFProjectBuilder {
                 id: product.pifTargetGUID(suffix: targetSuffix),
                 productType: productType,
                 name: product.targetName(suffix: targetSuffix),
-                productName: "$(EXECUTABLE_NAME)"
+                productName: productName
             )
         }
         do {
diff --git a/Tests/CommandsTests/BuildCommandTests.swift b/Tests/CommandsTests/BuildCommandTests.swift
@@ -1504,6 +1504,38 @@ struct BuildCommandTestCases {
             buildSystem != .swiftbuild
         }
     }
+
+
+    @Test(
+         .requireHostOS(.macOS),
+        arguments: getBuildData(for: [.swiftbuild]),
+    )
+    func dynamicLibrariesAsFrameworks(
+        data: BuildData,
+    ) async throws {
+        let buildSystem = data.buildSystem
+        try await withKnownIssue {
+            try await fixture(name: "Miscellaneous/DynamicProduct") { fixturePath in
+                let aPath = fixturePath.appending("exec")
+                let result = try await build(
+                    ["--experimental-build-dylibs-as-frameworks"],
+                    packagePath: aPath,
+                    configuration: data.config,
+                    cleanAfterward: false,
+                    buildSystem: buildSystem,
+                )
+                #expect(result.binContents.contains("PackageFrameworks"))
+                #expect(result.binContents.contains("exec"))
+
+                let frameworks = try localFileSystem.getDirectoryContents(result.binPath.appending("PackageFrameworks"))
+                #expect(frameworks.contains("firstDyna.framework"))
+                #expect(frameworks.contains("secondDyna.framework"))
+
+            }
+        } when: {
+            data.config == .release
+        }
+    }
 }
 
 extension Triple {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# exec`
	`2`	`+`
	`3`	`+A description of this package.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import secondDyna`
	`2`	`+`
	`3`	`+print(secondDyna.hello())`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# firstDyna`
	`2`	`+`
	`3`	`+A description of this package.`