rdar://164182636 Pass back PRODUCT_MODULE_NAME to previews as target dependency info (#895)

Author: jonathanpenn

Sources/SWBBuildService/Messages.swift

@@ -1092,6 +1092,7 @@ private extension PreviewInfoOutput {
         case let .targetDependencyInfo(info):
             kind = .targetDependencyInfo(
                 PreviewInfoTargetDependencyInfo(
+                    productModuleName: info.productModuleName,
                     objectFileInputMap: info.objectFileInputMap,
                     linkCommandLine: info.linkCommandLine,
                     linkerWorkingDirectory: info.linkerWorkingDirectory,

Sources/SWBBuildService/PreviewInfo.swift

@@ -50,6 +50,7 @@ package struct PreviewInfoOutput: Sendable {
     }
 
     package struct TargetDependencyInfo: Sendable {
+        package let productModuleName: String
         package let objectFileInputMap: [String: Set<String>]
         package let linkCommandLine: [String]
         package let linkerWorkingDirectory: String?
@@ -265,6 +266,7 @@ extension BuildDescription {
                     case .targetDependencyInfo:
                         let swiftInfos = Dictionary(grouping: relevantPreviewInfos.filter({ $0.type == .Swift }), by: { $0.output.str }).mapValues { Set($0.map { $0.input.str }) }
                         let targetInfo = PreviewInfoOutput.TargetDependencyInfo(
+                            productModuleName: settings.globalScope.evaluate(BuiltinMacros.PRODUCT_MODULE_NAME),
                             objectFileInputMap: swiftInfos,
                             linkCommandLine: linkInfo?.commandLine ?? [],
                             linkerWorkingDirectory: linkInfo?.workingDirectory.str,

Sources/SWBProtocol/MessageSupport.swift

@@ -443,6 +443,7 @@ public struct PreviewInfoThunkInfo: Codable, Equatable, Sendable {
 }
 
 public struct PreviewInfoTargetDependencyInfo: Codable, Equatable, Sendable {
+    public let productModuleName: String
     public let objectFileInputMap: [String: Set<String>]
     public let linkCommandLine: [String]
     public let linkerWorkingDirectory: String?
@@ -455,6 +456,7 @@ public struct PreviewInfoTargetDependencyInfo: Codable, Equatable, Sendable {
     public let enableUndefinedBehaviorSanitizer: Bool
 
     public init(
+        productModuleName: String,
         objectFileInputMap: [String : Set<String>],
         linkCommandLine: [String],
         linkerWorkingDirectory: String?,
@@ -466,6 +468,7 @@ public struct PreviewInfoTargetDependencyInfo: Codable, Equatable, Sendable {
         enableThreadSanitizer: Bool,
         enableUndefinedBehaviorSanitizer: Bool
     ) {
+        self.productModuleName = productModuleName
         self.objectFileInputMap = objectFileInputMap
         self.linkCommandLine = linkCommandLine
         self.linkerWorkingDirectory = linkerWorkingDirectory

Sources/SwiftBuild/SWBBuildServiceSession.swift

@@ -990,6 +990,7 @@ fileprivate extension SWBPreviewTargetDependencyInfo {
         case .thunkInfo:
             throw StubError.error("Unexpected response type for request")
         case let .targetDependencyInfo(targetDependencyInfo):
+            self.productModuleName = targetDependencyInfo.productModuleName
             self.objectFileInputMap = targetDependencyInfo.objectFileInputMap
             self.linkCommandLine = targetDependencyInfo.linkCommandLine
             self.linkerWorkingDirectory = targetDependencyInfo.linkerWorkingDirectory

Sources/SwiftBuild/SWBPreviewSupport.swift

@@ -60,6 +60,8 @@ public struct SWBPreviewTargetDependencyInfo: SWBPreviewInfoContext, Hashable, S
 
     public let pifGUID: String
 
+    public let productModuleName: String
+
     /// Mapping of object files to the source file inputs they came from.
     public let objectFileInputMap: [String: Set<String>]
 
@@ -110,6 +112,7 @@ public struct SWBPreviewTargetDependencyInfo: SWBPreviewInfoContext, Hashable, S
         buildVariant: String,
         architecture: String,
         pifGUID: String,
+        productModuleName: String,
         objectFileInputMap: [String : Set<String>],
         linkCommandLine: [String],
         linkerWorkingDirectory: String?,
@@ -126,6 +129,7 @@ public struct SWBPreviewTargetDependencyInfo: SWBPreviewInfoContext, Hashable, S
         self.buildVariant = buildVariant
         self.architecture = architecture
         self.pifGUID = pifGUID
+        self.productModuleName = productModuleName
         self.objectFileInputMap = objectFileInputMap
         self.linkCommandLine = linkCommandLine
         self.linkerWorkingDirectory = linkerWorkingDirectory

Tests/SWBBuildSystemTests/PreviewsBuildOperationTests.swift

@@ -299,6 +299,7 @@ fileprivate struct PreviewsBuildOperationTests: CoreBasedTests {
                         #expect(targetPreviewInfo.context.sdkRoot == core.loadSDK(.iOSSimulator).name)
                         #expect(targetPreviewInfo.context.sdkVariant == "iphonesimulator")
 
+                        #expect(targetPreviewInfo.targetDependencyInfo?.productModuleName == "AppTarget")
                         #expect(targetPreviewInfo.targetDependencyInfo?.objectFileInputMap == [
                             "\(srcRoot.str)/build/ProjectName.build/Debug-iphonesimulator/AppTarget.build/Objects-normal/\(results.runDestinationTargetArchitecture)/main.o": Set(["\(srcRoot.str)/Sources/main.swift"])
                             ])
@@ -603,6 +604,7 @@ fileprivate struct PreviewsBuildOperationTests: CoreBasedTests {
                         #expect(targetPreviewInfo.context.sdkRoot == core.loadSDK(.iOSSimulator).name)
                         #expect(targetPreviewInfo.context.sdkVariant == "iphonesimulator")
 
+                        #expect(targetPreviewInfo.targetDependencyInfo?.productModuleName == "AppTarget")
                         #expect(targetPreviewInfo.targetDependencyInfo?.objectFileInputMap == [
                             "\(srcRoot.str)/build/ProjectName.build/Debug-iphonesimulator/AppTarget.build/Objects-normal/\(results.runDestinationTargetArchitecture)/main.o": Set(["\(srcRoot.str)/Sources/main.swift"]),
                             "\(srcRoot.str)/build/ProjectName.build/Debug-iphonesimulator/AppTarget.build/Objects-normal/\(results.runDestinationTargetArchitecture)/File1.o": Set(["\(srcRoot.str)/Sources/File1.swift"]),

Tests/SwiftBuildTests/GeneratePreviewInfoTests.swift

@@ -206,6 +206,7 @@ fileprivate struct GeneratePreviewInfoTests: CoreBasedTests {
                             buildVariant: "normal",
                             architecture: activeRunDestination.targetArchitecture,
                             pifGUID: appTarget.guid,
+                            productModuleName: "App",
                             objectFileInputMap: [
                                 "\(tmpDir.str)/Test/build/Test.build/Debug-iphoneos/App.build/Objects-normal/\(activeRunDestination.targetArchitecture)/TestFile4.o": Set(["\(tmpDir.str)/Test/TestFile4.swift"]),
                                 "\(tmpDir.str)/Test/build/Test.build/Debug-iphoneos/App.build/Objects-normal/\(activeRunDestination.targetArchitecture)/GeneratedAssetSymbols.o": Set(["\(tmpDir.str)/Test/build/Test.build/Debug-iphoneos/App.build/DerivedSources/GeneratedAssetSymbols.swift"])
@@ -381,6 +382,7 @@ fileprivate struct GeneratePreviewInfoTests: CoreBasedTests {
                             buildVariant: "normal",
                             architecture: activeRunDestination.targetArchitecture,
                             pifGUID: libTarget.guid,
+                            productModuleName: "StaticLib",
                             objectFileInputMap: [
                                 "\(tmpDir.str)/Test/build/Test.build/Debug-iphoneos/StaticLib.build/Objects-normal/arm64/TestFile4.o": Set(["\(tmpDir.str)/Test/TestFile4.swift"])
                             ],
@@ -505,6 +507,7 @@ fileprivate struct GeneratePreviewInfoTests: CoreBasedTests {
                             buildVariant: "normal",
                             architecture: activeRunDestination.targetArchitecture,
                             pifGUID: target.guid,
+                            productModuleName: "CApplication",
                             objectFileInputMap: [:],
                             linkCommandLine: [
                                 "\(developerDir)/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang",