AdopterAnalysis: record whether a framework has compatibility header and whether it's a mixed-source project

Author: nkcsgexi

Sources/SwiftDriver/Jobs/PrebuiltModulesJob.swift

@@ -250,15 +250,32 @@ public class SwiftAdopter: Codable {
   public let hasModule: Bool
   public let isFramework: Bool
   public let isPrivate: Bool
-  init(_ name: String, _ moduleDir: AbsolutePath, _ hasInterface: [AbsolutePath], _ hasModule: [AbsolutePath]) {
+  public let hasCompatibilityHeader: Bool
+  public let isMixed: Bool
+  init(_ name: String, _ moduleDir: AbsolutePath, _ hasInterface: [AbsolutePath], _ hasModule: [AbsolutePath]) throws {
     self.name = name
     self.moduleDir = SwiftAdopter.relativeToSDK(moduleDir)
     self.hasInterface = !hasInterface.isEmpty
     self.hasPrivateInterface = hasInterface.contains { $0.basename.hasSuffix(".private.swiftinterface") }
     self.hasModule = !hasModule.isEmpty
     self.isFramework = self.moduleDir.contains("\(name).framework")
     self.isPrivate = self.moduleDir.contains("PrivateFrameworks")
+    let headers = try SwiftAdopter.collectHeaderNames(moduleDir.parentDirectory.parentDirectory)
+    self.hasCompatibilityHeader = headers.contains { $0 == "\(name)-Swift.h" }
+    self.isMixed = headers.contains { $0 != "\(name)-Swift.h" }
   }
+
+  static func collectHeaderNames(_ headersIn: AbsolutePath) throws -> [String] {
+    var results: [String] = []
+    let collector = { (dir: AbsolutePath) in
+      guard localFileSystem.exists(dir) else { return }
+      try localFileSystem.getDirectoryContents(dir).forEach { results.append($0) }
+    }
+    try collector(headersIn.appending(component: "Headers"))
+    try collector(headersIn.appending(component: "PrivateHeaders"))
+    return results
+  }
+
   static func relativeToSDK(_ fullPath: AbsolutePath) -> String {
     var SDKDir: AbsolutePath = fullPath
     while(SDKDir.extension != "sdk") {
@@ -372,7 +389,7 @@ public struct SDKPrebuiltModuleInputsCollector {
           hasModule.append(currentFile)
         }
       }
-      allSwiftAdopters.append(SwiftAdopter(moduleName, dir, hasInterface, hasModule))
+      allSwiftAdopters.append(try! SwiftAdopter(moduleName, dir, hasInterface, hasModule))
     }
     // Search inside framework dirs in an SDK to find .swiftmodule directories.
     for dir in frameworkDirs {

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/B.framework/Modules/module.modulemap

@@ -0,0 +1,5 @@
+framework module B [extern_c] {
+  umbrella header "B.h"
+  export *
+  module * { export * }
+}

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/B.framework/PrivateHeaders/B-Swift.h

@@ -0,0 +1 @@
+// Nothing interesting

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/C.framework/Headers/C-API.h

@@ -0,0 +1 @@
+// nothing interesting

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/C.framework/Modules/C.swiftmodule/arm64-apple-macos.private.swiftinterface

@@ -0,0 +1,4 @@
+// swift-interface-format-version: 1.0
+// swift-module-flags: -module-name C
+import Swift
+public func FuncE() { }

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/C.framework/Modules/C.swiftmodule/arm64-apple-macos.swiftinterface

@@ -0,0 +1,4 @@
+// swift-interface-format-version: 1.0
+// swift-module-flags: -module-name C
+import Swift
+public func FuncE() { }

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/C.framework/Modules/C.swiftmodule/arm64e-apple-macos.swiftinterface

@@ -0,0 +1,4 @@
+// swift-interface-format-version: 1.0
+// swift-module-flags: -module-name C
+import Swift
+public func FuncE() { }

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/C.framework/Modules/C.swiftmodule/x86_64-apple-macos.swiftinterface

@@ -0,0 +1,4 @@
+// swift-interface-format-version: 1.0
+// swift-module-flags: -module-name C
+import Swift
+public func FuncE() { }

TestInputs/mock-sdk.Internal.sdk/System/Library/Frameworks/C.framework/Modules/module.modulemap

@@ -0,0 +1,5 @@
+framework module C [extern_c] {
+  umbrella header "C.h"
+  export *
+  module * { export * }
+}

Tests/SwiftDriverTests/ExplicitModuleBuildTests.swift

@@ -1555,5 +1555,22 @@ final class ExplicitModuleBuildTests: XCTestCase {
     XCTAssertFalse(B.hasModule)
     XCTAssertTrue(B.hasPrivateInterface)
   }
+
+  func testCollectSwiftAdoptersWhetherMixed() throws {
+    let mockSDKPath = testInputsPath.appending(component: "mock-sdk.Internal.sdk")
+    let mockSDKPathStr: String = mockSDKPath.pathString
+    let collector = try SDKPrebuiltModuleInputsCollector(VirtualPath(path: mockSDKPathStr).absolutePath!, DiagnosticsEngine())
+    let adopters = try collector.collectSwiftInterfaceMap().adopters
+    XCTAssertTrue(!adopters.isEmpty)
+    let B = adopters.first {$0.name == "B"}!
+    XCTAssertTrue(B.isFramework)
+    XCTAssertTrue(B.hasCompatibilityHeader)
+    XCTAssertFalse(B.isMixed)
+
+    let C = adopters.first {$0.name == "C"}!
+    XCTAssertTrue(C.isFramework)
+    XCTAssertFalse(C.hasCompatibilityHeader)
+    XCTAssertTrue(C.isMixed)
+  }
 #endif
 }