Merge pull request #913 from apple/es-mod2

Module aliasing: use real module names to resolve dependency graph with both default and fallback deps scanner 
Make isFramework property optional in SwiftModuleDetails/SwiftPrebuiltExternalModuleDetails to fix JSON Decoding error
Resolves rdar://85525296

Author: elsh

Sources/SwiftDriver/ExplicitModuleBuilds/ExplicitDependencyBuildPlanner.swift

@@ -313,7 +313,7 @@ public typealias ExternalTargetModuleDetailsMap = [ModuleDependencyId: ExternalT
           let isFramework: Bool
           swiftModulePath = .init(file: dependencyInfo.modulePath.path,
                                   type: .swiftModule)
-          isFramework = try dependencyGraph.swiftModuleDetails(of: dependencyId).isFramework
+          isFramework = try dependencyGraph.swiftModuleDetails(of: dependencyId).isFramework ?? false
           // Accumulate the required information about this dependency
           // TODO: add .swiftdoc and .swiftsourceinfo for this module.
           swiftDependencyArtifacts.append(
@@ -336,7 +336,7 @@ public typealias ExternalTargetModuleDetailsMap = [ModuleDependencyId: ExternalT
         case .swiftPrebuiltExternal:
           let prebuiltModuleDetails = try dependencyGraph.swiftPrebuiltDetails(of: dependencyId)
           let compiledModulePath = prebuiltModuleDetails.compiledModulePath
-          let isFramework = prebuiltModuleDetails.isFramework
+          let isFramework = prebuiltModuleDetails.isFramework ?? false
           let swiftModulePath: TypedVirtualPath =
             .init(file: compiledModulePath.path, type: .swiftModule)
           // Accumulate the requried information about this dependency

Sources/SwiftDriver/ExplicitModuleBuilds/InterModuleDependencies/InterModuleDependencyGraph.swift

@@ -108,7 +108,7 @@ public struct SwiftModuleDetails: Codable {
   public var extraPcmArgs: [String]
 
   /// A flag to indicate whether or not this module is a framework.
-  public var isFramework: Bool
+  public var isFramework: Bool?
 }
 
 /// Details specific to Swift placeholder dependencies.
@@ -133,7 +133,7 @@ public struct SwiftPrebuiltExternalModuleDetails: Codable {
   public var moduleSourceInfoPath: TextualVirtualPath?
 
   /// A flag to indicate whether or not this module is a framework.
-  public var isFramework: Bool
+  public var isFramework: Bool?
 
   public init(compiledModulePath: TextualVirtualPath,
               moduleDocPath: TextualVirtualPath? = nil,
@@ -274,4 +274,23 @@ public struct InterModuleDependencyGraph: Codable {
 
 public struct InterModuleDependencyImports: Codable {
   public var imports: [String]
+  
+  public init(imports: [String], moduleAliases: [String: String]? = nil) {
+    var realImports = [String]()
+    if let aliases = moduleAliases {
+      for elem in imports {
+        if let realName = aliases[elem] {
+          realImports.append(realName)
+        } else {
+          realImports.append(elem)
+        }
+      }
+    }
+
+    if !realImports.isEmpty {
+      self.imports = realImports
+    } else {
+      self.imports = imports
+    }
+  }
 }

Sources/SwiftDriver/ExplicitModuleBuilds/InterModuleDependencies/InterModuleDependencyOracle.swift

@@ -31,33 +31,39 @@ public class InterModuleDependencyOracle {
   public init() {}
 
   @_spi(Testing) public func getDependencies(workingDirectory: AbsolutePath,
+                                             moduleAliases: [String: String]? = nil,
                                              commandLine: [String])
   throws -> InterModuleDependencyGraph {
     precondition(hasScannerInstance)
     return try queue.sync {
       return try swiftScanLibInstance!.scanDependencies(workingDirectory: workingDirectory,
+                                                        moduleAliases: moduleAliases,
                                                        invocationCommand: commandLine)
     }
   }
 
   @_spi(Testing) public func getBatchDependencies(workingDirectory: AbsolutePath,
+                                                  moduleAliases: [String: String]? = nil,
                                                   commandLine: [String],
                                                   batchInfos: [BatchScanModuleInfo])
   throws -> [ModuleDependencyId: [InterModuleDependencyGraph]] {
     precondition(hasScannerInstance)
     return try queue.sync {
       return try swiftScanLibInstance!.batchScanDependencies(workingDirectory: workingDirectory,
+                                                             moduleAliases: moduleAliases,
                                                             invocationCommand: commandLine,
                                                             batchInfos: batchInfos)
     }
   }
 
   @_spi(Testing) public func getImports(workingDirectory: AbsolutePath,
+                                        moduleAliases: [String: String]? = nil,
                                              commandLine: [String])
   throws -> InterModuleDependencyImports {
     precondition(hasScannerInstance)
     return try queue.sync {
       return try swiftScanLibInstance!.preScanImports(workingDirectory: workingDirectory,
+                                                      moduleAliases: moduleAliases,
                                                       invocationCommand: commandLine)
     }
   }

Sources/SwiftDriver/ExplicitModuleBuilds/ModuleDependencyScanning.swift

@@ -131,6 +131,7 @@ public extension Driver {
       sanitizeCommandForLibScanInvocation(&command)
       imports =
         try interModuleDependencyOracle.getImports(workingDirectory: cwd,
+                                                   moduleAliases: moduleOutputInfo.aliases,
                                                    commandLine: command)
 
     } else {
@@ -159,6 +160,7 @@ public extension Driver {
       sanitizeCommandForLibScanInvocation(&command)
       dependencyGraph =
         try interModuleDependencyOracle.getDependencies(workingDirectory: cwd,
+                                                        moduleAliases: moduleOutputInfo.aliases,
                                                         commandLine: command)
     } else {
       // Fallback to legacy invocation of the dependency scanner with
@@ -187,6 +189,7 @@ public extension Driver {
       sanitizeCommandForLibScanInvocation(&command)
       moduleVersionedGraphMap =
         try interModuleDependencyOracle.getBatchDependencies(workingDirectory: cwd,
+                                                             moduleAliases: moduleOutputInfo.aliases,
                                                              commandLine: command,
                                                              batchInfos: moduleInfos)
     } else {

Sources/SwiftDriver/SwiftScan/DependencyGraphBuilder.swift

@@ -15,7 +15,8 @@
 internal extension SwiftScan {
   /// From a reference to a binary-format dependency graph returned by libSwiftScan,
   /// construct an instance of an `InterModuleDependencyGraph`.
-  func constructGraph(from scannerGraphRef: swiftscan_dependency_graph_t) throws
+  func constructGraph(from scannerGraphRef: swiftscan_dependency_graph_t,
+                      moduleAliases: [String: String]?) throws
   -> InterModuleDependencyGraph {
     let mainModuleNameRef =
       api.swiftscan_dependency_graph_get_main_module_name(scannerGraphRef)
@@ -35,7 +36,7 @@ internal extension SwiftScan {
       guard let moduleRef = moduleRefOrNull else {
         throw DependencyScanningError.missingField("dependency_set_t.modules[_]")
       }
-      let (moduleId, moduleInfo) = try constructModuleInfo(from: moduleRef)
+      let (moduleId, moduleInfo) = try constructModuleInfo(from: moduleRef, moduleAliases: moduleAliases)
       resultGraph.modules[moduleId] = moduleInfo
     }
 
@@ -44,18 +45,20 @@ internal extension SwiftScan {
 
   /// From a reference to a binary-format set of module imports return by libSwiftScan pre-scan query,
   /// construct an instance of an `InterModuleDependencyImports` set
-  func constructImportSet(from importSetRef: swiftscan_import_set_t) throws
+  func constructImportSet(from importSetRef: swiftscan_import_set_t,
+                          with moduleAliases: [String: String]?) throws
   -> InterModuleDependencyImports {
     guard let importsRef = api.swiftscan_import_set_get_imports(importSetRef) else {
       throw DependencyScanningError.missingField("import_set.imports")
     }
-    return InterModuleDependencyImports(imports: try toSwiftStringArray(importsRef.pointee))
+    return InterModuleDependencyImports(imports: try toSwiftStringArray(importsRef.pointee), moduleAliases: moduleAliases)
   }
 
   /// From a reference to a binary-format dependency graph collection returned by libSwiftScan batch scan query,
   /// corresponding to the specified batch scan input (`BatchScanModuleInfo`), construct instances of
   /// `InterModuleDependencyGraph` for each result.
   func constructBatchResultGraphs(for batchInfos: [BatchScanModuleInfo],
+                                  moduleAliases: [String: String]?,
                                   from batchResultRef: swiftscan_batch_scan_result_t) throws
   -> [ModuleDependencyId: [InterModuleDependencyGraph]] {
     var resultMap: [ModuleDependencyId: [InterModuleDependencyGraph]] = [:]
@@ -66,7 +69,7 @@ internal extension SwiftScan {
       guard let resultGraphRef = resultGraphRefOrNull else {
         throw DependencyScanningError.dependencyScanFailed
       }
-      let decodedGraph = try constructGraph(from: resultGraphRef)
+      let decodedGraph = try constructGraph(from: resultGraphRef, moduleAliases: moduleAliases)
 
       let moduleId: ModuleDependencyId
       switch batchInfos[index] {
@@ -89,12 +92,13 @@ internal extension SwiftScan {
 private extension SwiftScan {
   /// From a reference to a binary-format module dependency module info returned by libSwiftScan,
   /// construct an instance of an `ModuleInfo` as used by the driver
-  func constructModuleInfo(from moduleInfoRef: swiftscan_dependency_info_t)
+  func constructModuleInfo(from moduleInfoRef: swiftscan_dependency_info_t,
+                           moduleAliases: [String: String]?)
   throws -> (ModuleDependencyId, ModuleInfo) {
     // Decode the module name and module kind
     let encodedModuleName =
       try toSwiftString(api.swiftscan_module_info_get_module_name(moduleInfoRef))
-    let moduleId = try decodeModuleNameAndKind(from: encodedModuleName)
+    let moduleId = try decodeModuleNameAndKind(from: encodedModuleName, moduleAliases: moduleAliases)
 
     // Decode module path and source file locations
     let modulePathStr = try toSwiftString(api.swiftscan_module_info_get_module_path(moduleInfoRef))
@@ -111,7 +115,7 @@ private extension SwiftScan {
     if let encodedDirectDepsRef = api.swiftscan_module_info_get_direct_dependencies(moduleInfoRef) {
       let encodedDirectDependencies = try toSwiftStringArray(encodedDirectDepsRef.pointee)
       directDependencies =
-        try encodedDirectDependencies.map { try decodeModuleNameAndKind(from: $0) }
+      try encodedDirectDependencies.map { try decodeModuleNameAndKind(from: $0, moduleAliases: moduleAliases) }
     } else {
       directDependencies = nil
     }
@@ -373,12 +377,21 @@ private extension SwiftScan {
   /// "swiftBinary"
   /// "swiftPlaceholder"
   /// "clang""
-  func decodeModuleNameAndKind(from encodedName: String) throws -> ModuleDependencyId {
+  func decodeModuleNameAndKind(from encodedName: String,
+                               moduleAliases: [String: String]?) throws -> ModuleDependencyId {
     switch encodedName {
       case _ where encodedName.starts(with: "swiftTextual:"):
-        return .swift(String(encodedName.suffix(encodedName.count - "swiftTextual:".count)))
+      var namePart = String(encodedName.suffix(encodedName.count - "swiftTextual:".count))
+      if let moduleAliases = moduleAliases, let realName = moduleAliases[namePart] {
+        namePart = realName
+      }
+      return .swift(namePart)
       case _ where encodedName.starts(with: "swiftBinary:"):
-        return .swiftPrebuiltExternal(String(encodedName.suffix(encodedName.count - "swiftBinary:".count)))
+        var namePart = String(encodedName.suffix(encodedName.count - "swiftBinary:".count))
+        if let moduleAliases = moduleAliases, let realName = moduleAliases[namePart] {
+          namePart = realName
+        }
+        return .swiftPrebuiltExternal(namePart)
       case _ where encodedName.starts(with: "swiftPlaceholder:"):
         return .swiftPlaceholder(String(encodedName.suffix(encodedName.count - "swiftPlaceholder:".count)))
       case _ where encodedName.starts(with: "clang:"):

Sources/SwiftDriver/SwiftScan/SwiftScan.swift

@@ -93,6 +93,7 @@ internal final class SwiftScan {
   }
 
   func preScanImports(workingDirectory: AbsolutePath,
+                      moduleAliases: [String: String]?,
                       invocationCommand: [String]) throws -> InterModuleDependencyImports {
     // Create and configure the scanner invocation
     let invocation = api.swiftscan_scan_invocation_create()
@@ -112,14 +113,15 @@ internal final class SwiftScan {
       throw DependencyScanningError.dependencyScanFailed
     }
 
-    let importSet = try constructImportSet(from: importSetRef)
+    let importSet = try constructImportSet(from: importSetRef, with: moduleAliases)
     // Free the memory allocated for the in-memory representation of the import set
     // returned by the scanner, now that we have translated it.
     api.swiftscan_import_set_dispose(importSetRef)
     return importSet
   }
 
   func scanDependencies(workingDirectory: AbsolutePath,
+                        moduleAliases: [String: String]?,
                         invocationCommand: [String]) throws -> InterModuleDependencyGraph {
     // Create and configure the scanner invocation
     let invocation = api.swiftscan_scan_invocation_create()
@@ -139,7 +141,7 @@ internal final class SwiftScan {
       throw DependencyScanningError.dependencyScanFailed
     }
 
-    let dependencyGraph = try constructGraph(from: graphRef)
+    let dependencyGraph = try constructGraph(from: graphRef, moduleAliases: moduleAliases)
     // Free the memory allocated for the in-memory representation of the dependency
     // graph returned by the scanner, now that we have translated it into an
     // `InterModuleDependencyGraph`.
@@ -148,6 +150,7 @@ internal final class SwiftScan {
   }
 
   func batchScanDependencies(workingDirectory: AbsolutePath,
+                             moduleAliases: [String: String]?,
                              invocationCommand: [String],
                              batchInfos: [BatchScanModuleInfo])
   throws -> [ModuleDependencyId: [InterModuleDependencyGraph]] {
@@ -201,6 +204,7 @@ internal final class SwiftScan {
     // Translate `swiftscan_batch_scan_result_t`
     // into `[ModuleDependencyId: [InterModuleDependencyGraph]]`
     let resultGraphMap = try constructBatchResultGraphs(for: batchInfos,
+                                                        moduleAliases:  moduleAliases,
                                                         from: batchResultRef.pointee)
     // Free the memory allocated for the in-memory representation of the batch scan
     // result, now that we have translated it.