Merge pull request swiftlang#1832 from ahoppen/reduce-absolute-path

Author: ahoppen

Package.swift

@@ -97,6 +97,7 @@ var targets: [Target] = [
       "SKTestSupport",
       "SourceKitLSP",
       "ToolchainRegistry",
+      "TSCExtensions",
     ],
     swiftSettings: globalSwiftSettings
   ),
@@ -348,7 +349,6 @@ var targets: [Target] = [
       "Csourcekitd",
       "SKLogging",
       "SwiftExtensions",
-      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
     ],
     exclude: ["CMakeLists.txt", "sourcekitd_uids.swift.gyb"],
     swiftSettings: globalSwiftSettings

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -13,7 +13,7 @@
 #if compiler(>=6)
 package import BuildServerProtocol
 import Dispatch
-import Foundation
+package import Foundation
 package import LanguageServerProtocol
 package import LanguageServerProtocolExtensions
 import SKLogging
@@ -23,8 +23,7 @@ package import SwiftExtensions
 package import ToolchainRegistry
 import TSCExtensions
 
-package import struct TSCBasic.AbsolutePath
-package import struct TSCBasic.RelativePath
+import struct TSCBasic.RelativePath
 #else
 import BuildServerProtocol
 import Dispatch
@@ -38,7 +37,6 @@ import SwiftExtensions
 import ToolchainRegistry
 import TSCExtensions
 
-import struct TSCBasic.AbsolutePath
 import struct TSCBasic.RelativePath
 #endif
 
@@ -138,31 +136,31 @@ private enum BuildSystemAdapter {
 
 private extension BuildSystemSpec {
   private static func createBuiltInBuildSystemAdapter(
-    projectRoot: AbsolutePath,
+    projectRoot: URL,
     messagesToSourceKitLSPHandler: any MessageHandler,
     buildSystemTestHooks: BuildSystemTestHooks,
     _ createBuildSystem: @Sendable (_ connectionToSourceKitLSP: any Connection) async throws -> BuiltInBuildSystem?
   ) async -> BuildSystemAdapter? {
     let connectionToSourceKitLSP = LocalConnection(
-      receiverName: "BuildSystemManager for \(projectRoot.asURL.lastPathComponent)"
+      receiverName: "BuildSystemManager for \(projectRoot.lastPathComponent)"
     )
     connectionToSourceKitLSP.start(handler: messagesToSourceKitLSPHandler)
 
     let buildSystem = await orLog("Creating build system") {
       try await createBuildSystem(connectionToSourceKitLSP)
     }
     guard let buildSystem else {
-      logger.log("Failed to create build system at \(projectRoot.pathString)")
+      logger.log("Failed to create build system at \(projectRoot)")
       return nil
     }
-    logger.log("Created \(type(of: buildSystem), privacy: .public) at \(projectRoot.pathString)")
+    logger.log("Created \(type(of: buildSystem), privacy: .public) at \(projectRoot)")
     let buildSystemAdapter = BuiltInBuildSystemAdapter(
       underlyingBuildSystem: buildSystem,
       connectionToSourceKitLSP: connectionToSourceKitLSP,
       buildSystemTestHooks: buildSystemTestHooks
     )
     let connectionToBuildSystem = LocalConnection(
-      receiverName: "\(type(of: buildSystem)) for \(projectRoot.asURL.lastPathComponent)"
+      receiverName: "\(type(of: buildSystem)) for \(projectRoot.lastPathComponent)"
     )
     connectionToBuildSystem.start(handler: buildSystemAdapter)
     return .builtIn(buildSystemAdapter, connectionToBuildSystem: connectionToBuildSystem)
@@ -185,10 +183,10 @@ private extension BuildSystemSpec {
         )
       }
       guard let buildSystem else {
-        logger.log("Failed to create external build system at \(projectRoot.pathString)")
+        logger.log("Failed to create external build system at \(projectRoot)")
         return nil
       }
-      logger.log("Created external build server at \(projectRoot.pathString)")
+      logger.log("Created external build server at \(projectRoot)")
       return .external(buildSystem)
     case .compilationDatabase:
       return await Self.createBuiltInBuildSystemAdapter(
@@ -245,7 +243,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
   /// For compilation databases it is the root folder based on which the compilation database was found.
   ///
   /// `nil` if the `BuildSystemManager` does not have an underlying build system.
-  package let projectRoot: AbsolutePath?
+  package let projectRoot: URL?
 
   /// The files for which the delegate has requested change notifications, ie. the files for which the delegate wants to
   /// get `fileBuildSettingsChanged` and `filesDependenciesUpdated` callbacks.
@@ -402,7 +400,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
             displayName: "SourceKit-LSP",
             version: "",
             bspVersion: "2.2.0",
-            rootUri: URI(buildSystemSpec.projectRoot.asURL),
+            rootUri: URI(buildSystemSpec.projectRoot),
             capabilities: BuildClientCapabilities(languageIds: [.c, .cpp, .objective_c, .objective_cpp, .swift])
           )
         )
@@ -608,7 +606,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
     in target: BuildTargetIdentifier?,
     language: Language
   ) async -> Toolchain? {
-    let toolchainPath = await orLog("Getting toolchain from build targets") { () -> AbsolutePath? in
+    let toolchainPath = await orLog("Getting toolchain from build targets") { () -> URL? in
       guard let target else {
         return nil
       }
@@ -624,7 +622,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
         logger.error("Toolchain is not a file URL")
         return nil
       }
-      return try AbsolutePath(validating: toolchainUrl.filePath)
+      return toolchainUrl
     }
     if let toolchainPath {
       if let toolchain = await self.toolchainRegistry.toolchain(withPath: toolchainPath) {
@@ -681,11 +679,9 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
       if let targets = filesAndDirectories.files[document]?.targets {
         result.formUnion(targets)
       }
-      if !filesAndDirectories.directories.isEmpty,
-        let documentPath = AbsolutePath(validatingOrNil: try? document.fileURL?.filePath)
-      {
+      if !filesAndDirectories.directories.isEmpty, let documentPath = document.fileURL {
         for (directory, info) in filesAndDirectories.directories {
-          guard let directoryPath = AbsolutePath(validatingOrNil: try? directory.fileURL?.filePath) else {
+          guard let directoryPath = directory.fileURL else {
             continue
           }
           if documentPath.isDescendant(of: directoryPath) {

Sources/BuildSystemIntegration/BuiltInBuildSystem.swift

@@ -12,22 +12,18 @@
 
 #if compiler(>=6)
 package import BuildServerProtocol
+package import Foundation
 package import LanguageServerProtocol
 import SKLogging
 import SKOptions
 import ToolchainRegistry
-
-package import struct TSCBasic.AbsolutePath
-package import struct TSCBasic.RelativePath
 #else
 import BuildServerProtocol
+import Foundation
 import LanguageServerProtocol
 import SKLogging
 import SKOptions
 import ToolchainRegistry
-
-import struct TSCBasic.AbsolutePath
-import struct TSCBasic.RelativePath
 #endif
 
 /// An error build systems can throw from `prepare` if they don't support preparation of targets.
@@ -42,16 +38,16 @@ package protocol BuiltInBuildSystem: AnyObject, Sendable {
   /// The root of the project that this build system manages. For example, for SwiftPM packages, this is the folder
   /// containing Package.swift. For compilation databases it is the root folder based on which the compilation database
   /// was found.
-  var projectRoot: AbsolutePath { get async }
+  var projectRoot: URL { get async }
 
   /// The files to watch for changes.
   var fileWatchers: [FileSystemWatcher] { get async }
 
   /// The path to the raw index store data, if any.
-  var indexStorePath: AbsolutePath? { get async }
+  var indexStorePath: URL? { get async }
 
   /// The path to put the index database, if any.
-  var indexDatabasePath: AbsolutePath? { get async }
+  var indexDatabasePath: URL? { get async }
 
   /// Whether the build system is capable of preparing a target for indexing, ie. if the `prepare` methods has been
   /// implemented.

Sources/BuildSystemIntegration/BuiltInBuildSystemAdapter.swift

@@ -11,7 +11,6 @@
 //===----------------------------------------------------------------------===//
 
 import BuildServerProtocol
-import Foundation
 import LanguageServerProtocol
 import LanguageServerProtocolExtensions
 import SKLogging
@@ -20,11 +19,9 @@ import SwiftExtensions
 import ToolchainRegistry
 
 #if compiler(>=6)
-package import struct TSCBasic.AbsolutePath
-package import struct TSCBasic.RelativePath
+package import Foundation
 #else
-import struct TSCBasic.AbsolutePath
-import struct TSCBasic.RelativePath
+import Foundation
 #endif
 
 /// The details necessary to create a `BuildSystemAdapter`.
@@ -38,9 +35,9 @@ package struct BuildSystemSpec {
 
   package var kind: Kind
 
-  package var projectRoot: AbsolutePath
+  package var projectRoot: URL
 
-  package init(kind: BuildSystemSpec.Kind, projectRoot: AbsolutePath) {
+  package init(kind: BuildSystemSpec.Kind, projectRoot: URL) {
     self.kind = kind
     self.projectRoot = projectRoot
   }
@@ -95,8 +92,12 @@ actor BuiltInBuildSystemAdapter: QueueBasedMessageHandler {
       capabilities: BuildServerCapabilities(),
       dataKind: .sourceKit,
       data: SourceKitInitializeBuildResponseData(
-        indexDatabasePath: await underlyingBuildSystem.indexDatabasePath?.pathString,
-        indexStorePath: await underlyingBuildSystem.indexStorePath?.pathString,
+        indexDatabasePath: await orLog("getting index database file path") {
+          try await underlyingBuildSystem.indexDatabasePath?.filePath
+        },
+        indexStorePath: await orLog("getting index store file path") {
+          try await underlyingBuildSystem.indexStorePath?.filePath
+        },
         watchers: await underlyingBuildSystem.fileWatchers,
         prepareProvider: underlyingBuildSystem.supportsPreparation,
         sourceKitOptionsProvider: true

Sources/BuildSystemIntegration/CompilationDatabase.swift

@@ -12,17 +12,14 @@
 
 #if compiler(>=6)
 package import BuildServerProtocol
-import Foundation
+package import Foundation
 package import LanguageServerProtocol
 import LanguageServerProtocolExtensions
 import SKLogging
 import SwiftExtensions
 import TSCExtensions
 
-package import struct TSCBasic.AbsolutePath
-package import protocol TSCBasic.FileSystem
 package import struct TSCBasic.RelativePath
-package import var TSCBasic.localFileSystem
 #else
 import BuildServerProtocol
 import Foundation
@@ -32,10 +29,7 @@ import SKLogging
 import SwiftExtensions
 import TSCExtensions
 
-import struct TSCBasic.AbsolutePath
-import protocol TSCBasic.FileSystem
 import struct TSCBasic.RelativePath
-import var TSCBasic.localFileSystem
 #endif
 
 #if os(Windows)
@@ -124,9 +118,8 @@ package protocol CompilationDatabase {
 
 /// Loads the compilation database located in `directory`, if one can be found in `additionalSearchPaths` or in the default search paths of "." and "build".
 package func tryLoadCompilationDatabase(
-  directory: AbsolutePath,
-  additionalSearchPaths: [RelativePath] = [],
-  _ fileSystem: FileSystem = localFileSystem
+  directory: URL,
+  additionalSearchPaths: [RelativePath] = []
 ) -> CompilationDatabase? {
   let searchPaths =
     additionalSearchPaths + [
@@ -140,10 +133,10 @@ package func tryLoadCompilationDatabase(
     .map { directory.appending($0) }
     .compactMap { searchPath in
       orLog("Failed to load compilation database") { () -> CompilationDatabase? in
-        if let compDb = try JSONCompilationDatabase(directory: searchPath, fileSystem) {
+        if let compDb = try JSONCompilationDatabase(directory: searchPath) {
           return compDb
         }
-        if let compDb = try FixedCompilationDatabase(directory: searchPath, fileSystem) {
+        if let compDb = try FixedCompilationDatabase(directory: searchPath) {
           return compDb
         }
         return nil
@@ -178,30 +171,26 @@ package struct FixedCompilationDatabase: CompilationDatabase, Equatable {
 
   /// Loads the compilation database located in `directory`, if any.
   /// - Returns: `nil` if `compile_flags.txt` was not found
-  package init?(directory: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
-    let path = directory.appending(component: "compile_flags.txt")
-    try self.init(file: path, fileSystem)
+  package init?(directory: URL) throws {
+    let path = directory.appendingPathComponent("compile_flags.txt")
+    try self.init(file: path)
   }
 
   /// Loads the compilation database from `file`
   /// - Returns: `nil` if the file does not exist
-  package init?(file: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
-    self.directory = file.dirname
+  package init?(file: URL) throws {
+    self.directory = try file.deletingLastPathComponent().filePath
 
-    guard fileSystem.exists(file) else {
+    let fileContents: String
+    do {
+      fileContents = try String(contentsOf: file, encoding: .utf8)
+    } catch {
       return nil
     }
-    let bytes = try fileSystem.readFileContents(file)
 
     var fixedArgs: [String] = ["clang"]
-    try bytes.withUnsafeData { data in
-      guard let fileContents = String(data: data, encoding: .utf8) else {
-        throw CompilationDatabaseDecodingError.fixedDatabaseDecodingError
-      }
-
-      fileContents.enumerateLines { line, _ in
-        fixedArgs.append(line.trimmingCharacters(in: .whitespacesAndNewlines))
-      }
+    fileContents.enumerateLines { line, _ in
+      fixedArgs.append(line.trimmingCharacters(in: .whitespacesAndNewlines))
     }
     self.fixedArgs = fixedArgs
   }
@@ -242,21 +231,21 @@ package struct JSONCompilationDatabase: CompilationDatabase, Equatable, Codable
   /// Loads the compilation database located in `directory`, if any.
   ///
   /// - Returns: `nil` if `compile_commands.json` was not found
-  package init?(directory: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
-    let path = directory.appending(component: "compile_commands.json")
-    try self.init(file: path, fileSystem)
+  package init?(directory: URL) throws {
+    let path = directory.appendingPathComponent("compile_commands.json")
+    try self.init(file: path)
   }
 
   /// Loads the compilation database from `file`
   /// - Returns: `nil` if the file does not exist
-  package init?(file: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
-    guard fileSystem.exists(file) else {
+  package init?(file: URL) throws {
+    let data: Data
+    do {
+      data = try Data(contentsOf: file)
+    } catch {
       return nil
     }
-    let bytes = try fileSystem.readFileContents(file)
-    try bytes.withUnsafeData { data in
-      self = try JSONDecoder().decode(JSONCompilationDatabase.self, from: data)
-    }
+    self = try JSONDecoder().decode(JSONCompilationDatabase.self, from: data)
   }
 
   package func encode(to encoder: Encoder) throws {