Use BuildTargetIdentifier from BSP instead of ConfiguredTarget

Author: ahoppen

Sources/BuildSystemIntegration/BuildServerBuildSystem.swift

@@ -269,7 +269,7 @@ extension BuildServerBuildSystem: BuiltInBuildSystem {
   /// server yet or if no build settings are available for this file.
   package func buildSettings(
     for document: DocumentURI,
-    in target: ConfiguredTarget,
+    in target: BuildTargetIdentifier,
     language: Language
   ) async -> FileBuildSettings? {
     return buildSettings[document]
@@ -283,24 +283,24 @@ extension BuildServerBuildSystem: BuiltInBuildSystem {
     return nil
   }
 
-  package func configuredTargets(for document: DocumentURI) async -> [ConfiguredTarget] {
-    return [ConfiguredTarget(targetID: "dummy", runDestinationID: "dummy")]
+  package func targets(for document: DocumentURI) async -> [BuildTargetIdentifier] {
+    return [BuildTargetIdentifier.dummy]
   }
 
   package func generateBuildGraph() {}
 
   package func waitForUpToDateBuildGraph() async {}
 
-  package func topologicalSort(of targets: [ConfiguredTarget]) async -> [ConfiguredTarget]? {
+  package func topologicalSort(of targets: [BuildTargetIdentifier]) async -> [BuildTargetIdentifier]? {
     return nil
   }
 
-  package func targets(dependingOn targets: [ConfiguredTarget]) -> [ConfiguredTarget]? {
+  package func targets(dependingOn targets: [BuildTargetIdentifier]) -> [BuildTargetIdentifier]? {
     return nil
   }
 
   package func prepare(
-    targets: [ConfiguredTarget],
+    targets: [BuildTargetIdentifier],
     logMessageToIndexLog: @Sendable (_ taskID: IndexTaskID, _ message: String) -> Void
   ) async throws {
     throw PrepareNotSupportedError()

Sources/BuildSystemIntegration/BuildSystem.swift

@@ -50,35 +50,6 @@ package struct SourceFileInfo: Sendable {
   }
 }
 
-/// A target / run destination combination. For example, a configured target can represent building the target
-/// `MyLibrary` for iOS.
-package struct ConfiguredTarget: Hashable, Sendable, CustomLogStringConvertible {
-  /// An opaque string that represents the target.
-  ///
-  /// The target's ID should be generated by the build system that handles the target and only interpreted by that
-  /// build system.
-  package let targetID: String
-
-  /// An opaque string that represents the run destination.
-  ///
-  /// The run destination's ID should be generated by the build system that handles the target and only interpreted by
-  /// that build system.
-  package let runDestinationID: String
-
-  package init(targetID: String, runDestinationID: String) {
-    self.targetID = targetID
-    self.runDestinationID = runDestinationID
-  }
-
-  package var description: String {
-    "\(targetID)-\(runDestinationID)"
-  }
-
-  package var redactedDescription: String {
-    "\(targetID.hashForLogging)-\(runDestinationID.hashForLogging)"
-  }
-}
-
 /// An error build systems can throw from `prepare` if they don't support preparation of targets.
 package struct PrepareNotSupportedError: Error, CustomStringConvertible {
   package init() {}
@@ -135,12 +106,12 @@ package protocol BuiltInBuildSystem: AnyObject, Sendable {
   /// file or if it hasn't computed build settings for the file yet.
   func buildSettings(
     for document: DocumentURI,
-    in target: ConfiguredTarget,
+    in target: BuildTargetIdentifier,
     language: Language
   ) async throws -> FileBuildSettings?
 
   /// Return the list of targets and run destinations that the given document can be built for.
-  func configuredTargets(for document: DocumentURI) async -> [ConfiguredTarget]
+  func targets(for document: DocumentURI) async -> [BuildTargetIdentifier]
 
   /// Re-generate the build graph.
   func generateBuildGraph() async throws
@@ -154,7 +125,7 @@ package protocol BuiltInBuildSystem: AnyObject, Sendable {
   /// index data to be available earlier.
   ///
   /// `nil` if the build system doesn't support topological sorting of targets.
-  func topologicalSort(of targets: [ConfiguredTarget]) async -> [ConfiguredTarget]?
+  func topologicalSort(of targets: [BuildTargetIdentifier]) async -> [BuildTargetIdentifier]?
 
   /// Returns the list of targets that might depend on the given target and that need to be re-prepared when a file in
   /// `target` is modified.
@@ -163,12 +134,12 @@ package protocol BuiltInBuildSystem: AnyObject, Sendable {
   /// necessary by scheduling re-preparation of a target where it isn't necessary.
   ///
   /// Returning `nil` indicates that all targets should be considered depending on the given target.
-  func targets(dependingOn targets: [ConfiguredTarget]) async -> [ConfiguredTarget]?
+  func targets(dependingOn targets: [BuildTargetIdentifier]) async -> [BuildTargetIdentifier]?
 
   /// Prepare the given targets for indexing and semantic functionality. This should build all swift modules of target
   /// dependencies.
   func prepare(
-    targets: [ConfiguredTarget],
+    targets: [BuildTargetIdentifier],
     logMessageToIndexLog: @escaping @Sendable (_ taskID: IndexTaskID, _ message: String) -> Void
   ) async throws
 

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -160,23 +160,22 @@ package actor BuildSystemManager: BuiltInBuildSystemAdapterDelegate {
     }
   }
 
-  /// Returns all the `ConfiguredTarget`s that the document is part of.
-  package func configuredTargets(for document: DocumentURI) async -> [ConfiguredTarget] {
-    return await buildSystem?.underlyingBuildSystem.configuredTargets(for: document) ?? []
-  }
-
-  /// Returns the `ConfiguredTarget` that should be used for semantic functionality of the given document.
-  package func canonicalConfiguredTarget(for document: DocumentURI) async -> ConfiguredTarget? {
-    // Sort the configured targets to deterministically pick the same `ConfiguredTarget` every time.
-    // We could allow the user to specify a preference of one target over another. For now this is not necessary because
-    // no build system currently returns multiple targets for a source file.
-    return await configuredTargets(for: document)
-      .sorted { ($0.targetID, $0.runDestinationID) < ($1.targetID, $1.runDestinationID) }
+  /// Returns all the `BuildTargetIdentifier`s that the document is part of.
+  package func targets(for document: DocumentURI) async -> [BuildTargetIdentifier] {
+    return await buildSystem?.underlyingBuildSystem.targets(for: document) ?? []
+  }
+
+  /// Returns the `BuildTargetIdentifier` that should be used for semantic functionality of the given document.
+  package func canonicalTarget(for document: DocumentURI) async -> BuildTargetIdentifier? {
+    // Sort the targets to deterministically pick the same `BuildTargetIdentifier` every time.
+    // We could allow the user to specify a preference of one target over another.
+    return await targets(for: document)
+      .sorted { $0.uri.stringValue < $1.uri.stringValue }
       .first
   }
 
-  /// Returns the target's module name as parsed from the `ConfiguredTarget`'s compiler arguments.
-  package func moduleName(for document: DocumentURI, in target: ConfiguredTarget) async -> String? {
+  /// Returns the target's module name as parsed from the `BuildTargetIdentifier`'s compiler arguments.
+  package func moduleName(for document: DocumentURI, in target: BuildTargetIdentifier) async -> String? {
     guard let language = await self.defaultLanguage(for: document),
       let buildSettings = await buildSettings(for: document, in: target, language: language)
     else {
@@ -211,7 +210,7 @@ package actor BuildSystemManager: BuiltInBuildSystemAdapterDelegate {
   /// Implementation detail of `buildSettings(for:language:)`.
   private func buildSettingsFromPrimaryBuildSystem(
     for document: DocumentURI,
-    in target: ConfiguredTarget?,
+    in target: BuildTargetIdentifier?,
     language: Language
   ) async throws -> FileBuildSettings? {
     guard let buildSystem, let target else {
@@ -232,7 +231,7 @@ package actor BuildSystemManager: BuiltInBuildSystemAdapterDelegate {
   /// don't have build settings by themselves.
   package func buildSettings(
     for document: DocumentURI,
-    in target: ConfiguredTarget?,
+    in target: BuildTargetIdentifier?,
     language: Language
   ) async -> FileBuildSettings? {
     do {
@@ -271,7 +270,7 @@ package actor BuildSystemManager: BuiltInBuildSystemAdapterDelegate {
     language: Language
   ) async -> FileBuildSettings? {
     let mainFile = await mainFile(for: document, language: language)
-    let target = await canonicalConfiguredTarget(for: mainFile)
+    let target = await canonicalTarget(for: mainFile)
     guard var settings = await buildSettings(for: mainFile, in: target, language: language) else {
       return nil
     }
@@ -292,16 +291,16 @@ package actor BuildSystemManager: BuiltInBuildSystemAdapterDelegate {
     await self.buildSystem?.underlyingBuildSystem.waitForUpToDateBuildGraph()
   }
 
-  package func topologicalSort(of targets: [ConfiguredTarget]) async throws -> [ConfiguredTarget]? {
+  package func topologicalSort(of targets: [BuildTargetIdentifier]) async throws -> [BuildTargetIdentifier]? {
     return await buildSystem?.underlyingBuildSystem.topologicalSort(of: targets)
   }
 
-  package func targets(dependingOn targets: [ConfiguredTarget]) async -> [ConfiguredTarget]? {
+  package func targets(dependingOn targets: [BuildTargetIdentifier]) async -> [BuildTargetIdentifier]? {
     return await buildSystem?.underlyingBuildSystem.targets(dependingOn: targets)
   }
 
   package func prepare(
-    targets: [ConfiguredTarget],
+    targets: [BuildTargetIdentifier],
     logMessageToIndexLog: @escaping @Sendable (_ taskID: IndexTaskID, _ message: String) -> Void
   ) async throws {
     try await buildSystem?.underlyingBuildSystem.prepare(targets: targets, logMessageToIndexLog: logMessageToIndexLog)

Sources/BuildSystemIntegration/BuildTargetIdentifierExtensions.swift

@@ -0,0 +1,28 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import BuildServerProtocol
+import SKLogging
+
+extension BuildTargetIdentifier {
+  package static let dummy: BuildTargetIdentifier = BuildTargetIdentifier(uri: try! URI(string: "dummy://dummy"))
+}
+
+extension BuildTargetIdentifier: CustomLogStringConvertible {
+  public var description: String {
+    return uri.stringValue
+  }
+
+  public var redactedDescription: String {
+    return uri.stringValue.hashForLogging
+  }
+}

Sources/BuildSystemIntegration/CMakeLists.txt

@@ -4,6 +4,7 @@ add_library(BuildSystemIntegration STATIC
   BuildSystem.swift
   BuildSystemDelegate.swift
   BuildSystemManager.swift
+  BuildTargetIdentifierExtensions.swift
   BuiltInBuildSystemAdapter.swift
   CompilationDatabase.swift
   CompilationDatabaseBuildSystem.swift

Sources/BuildSystemIntegration/CompilationDatabaseBuildSystem.swift

@@ -108,7 +108,7 @@ extension CompilationDatabaseBuildSystem: BuiltInBuildSystem {
 
   package func buildSettings(
     for document: DocumentURI,
-    in buildTarget: ConfiguredTarget,
+    in buildTarget: BuildTargetIdentifier,
     language: Language
   ) async -> FileBuildSettings? {
     guard let db = database(for: document),
@@ -128,12 +128,12 @@ extension CompilationDatabaseBuildSystem: BuiltInBuildSystem {
     return nil
   }
 
-  package func configuredTargets(for document: DocumentURI) async -> [ConfiguredTarget] {
-    return [ConfiguredTarget(targetID: "dummy", runDestinationID: "dummy")]
+  package func targets(for document: DocumentURI) async -> [BuildTargetIdentifier] {
+    return [BuildTargetIdentifier.dummy]
   }
 
   package func prepare(
-    targets: [ConfiguredTarget],
+    targets: [BuildTargetIdentifier],
     logMessageToIndexLog: @Sendable (_ taskID: IndexTaskID, _ message: String) -> Void
   ) async throws {
     throw PrepareNotSupportedError()
@@ -143,11 +143,11 @@ extension CompilationDatabaseBuildSystem: BuiltInBuildSystem {
 
   package func waitForUpToDateBuildGraph() async {}
 
-  package func topologicalSort(of targets: [ConfiguredTarget]) -> [ConfiguredTarget]? {
+  package func topologicalSort(of targets: [BuildTargetIdentifier]) -> [BuildTargetIdentifier]? {
     return nil
   }
 
-  package func targets(dependingOn targets: [ConfiguredTarget]) -> [ConfiguredTarget]? {
+  package func targets(dependingOn targets: [BuildTargetIdentifier]) -> [BuildTargetIdentifier]? {
     return nil
   }