adjust API to changes in SwiftPM (#433)

* adjust API to changes in SwiftPM

motivation: stay with the times

changes:
* use observability system instead of diganostics engine
* some APIs in SwiftPM are now throwing, adjust to this change

Author: tomerd

Sources/SKSwiftPMWorkspace/SwiftPMWorkspace.swift

@@ -13,6 +13,7 @@
 #if canImport(SPMBuildCore)
 import SPMBuildCore
 #endif
+import Basics
 import Build
 import BuildServerProtocol
 import LanguageServerProtocol
@@ -157,19 +158,21 @@ extension SwiftPMWorkspace {
   /// dependencies.
   func reloadPackage() throws {
 
-    let diags = DiagnosticsEngine(handlers: [{ diag in
-      log(diag.localizedDescription, level: diag.behavior.asLogLevel)
-    }])
+    let observabilitySystem = ObservabilitySystem({ scope, diagnostic in
+        log(diagnostic.description, level: diagnostic.severity.asLogLevel)
+    })
 
     self.packageGraph = try self.workspace.loadPackageGraph(
       rootInput: PackageGraphRootInput(packages: [packageRoot]),
-      diagnostics: diags)
+      observabilityScope: observabilitySystem.topScope
+    )
 
     let plan = try BuildPlan(
       buildParameters: buildParameters,
       graph: packageGraph,
-      diagnostics: diags,
-      fileSystem: fileSystem)
+      fileSystem: fileSystem,
+      observabilityScope: observabilitySystem.topScope
+    )
 
     self.fileToTarget = [AbsolutePath: TargetBuildDescription](
       packageGraph.allTargets.flatMap { target in
@@ -213,7 +216,7 @@ extension SwiftPMWorkspace: SKCore.BuildSystem {
 
   public func settings(
     for uri: DocumentURI,
-    _ language: Language) -> FileBuildSettings?
+    _ language: Language) throws -> FileBuildSettings?
   {
     guard let url = uri.fileURL else {
       // We can't determine build settings for non-file URIs.
@@ -224,15 +227,15 @@ extension SwiftPMWorkspace: SKCore.BuildSystem {
     }
 
     if let td = targetDescription(for: path) {
-      return settings(for: path, language, td)
+      return try settings(for: path, language, td)
     }
 
     if path.basename == "Package.swift" {
       return settings(forPackageManifest: path)
     }
 
     if path.extension == "h" {
-      return settings(forHeader: path, language)
+      return try settings(forHeader: path, language)
     }
 
     return nil
@@ -242,9 +245,18 @@ extension SwiftPMWorkspace: SKCore.BuildSystem {
     guard let delegate = self.delegate else { return }
 
     // TODO: Support for change detection (via file watching)
-    let settings = self.settings(for: uri, language)
+    var settings: FileBuildSettings? = nil
+    do {
+      settings = try self.settings(for: uri, language)
+    } catch {
+      log("error computing settings: \(error)")
+    }
     DispatchQueue.global().async {
-      delegate.fileBuildSettingsChanged([uri: FileBuildSettingsChange(settings)])
+      if let settings = settings {
+        delegate.fileBuildSettingsChanged([uri: FileBuildSettingsChange(settings)])
+      } else {
+        delegate.fileBuildSettingsChanged([uri: .removedOrUnavailable])
+      }
     }
   }
 
@@ -291,15 +303,15 @@ extension SwiftPMWorkspace {
   public func settings(
     for path: AbsolutePath,
     _ language: Language,
-    _ td: TargetBuildDescription) -> FileBuildSettings?
+    _ td: TargetBuildDescription) throws -> FileBuildSettings?
   {
     switch (td, language) {
     case (.swift(let td), .swift):
-      return settings(forSwiftFile: path, td)
+      return try settings(forSwiftFile: path, td)
     case (.clang, .swift):
       return nil
     case (.clang(let td), _):
-      return settings(forClangFile: path, language, td)
+      return try settings(forClangFile: path, language, td)
     default:
       return nil
     }
@@ -314,8 +326,8 @@ extension SwiftPMWorkspace {
       }
       return nil
     }
-    
-    if let result = impl(path) { 
+
+    if let result = impl(path) {
       return result
     }
 
@@ -324,30 +336,30 @@ extension SwiftPMWorkspace {
   }
 
   /// Retrieve settings for a given header file.
-  public func settings(forHeader path: AbsolutePath, _ language: Language) -> FileBuildSettings? {
-    func impl(_ path: AbsolutePath) -> FileBuildSettings? {
+  public func settings(forHeader path: AbsolutePath, _ language: Language) throws -> FileBuildSettings? {
+    func impl(_ path: AbsolutePath) throws -> FileBuildSettings? {
       var dir = path.parentDirectory
       while !dir.isRoot {
         if let td = sourceDirToTarget[dir] {
-          return settings(for: path, language, td)
+          return try settings(for: path, language, td)
         }
         dir = dir.parentDirectory
       }
       return nil
     }
-    
-    if let result = impl(path) { 
+
+    if let result = try impl(path) {
       return result
     }
 
     let canonicalPath = resolveSymlinks(path)
-    return canonicalPath == path ? nil : impl(canonicalPath)
+    return try canonicalPath == path ? nil : impl(canonicalPath)
   }
 
   /// Retrieve settings for the given swift file, which is part of a known target build description.
   public func settings(
     forSwiftFile path: AbsolutePath,
-    _ td: SwiftTargetBuildDescription) -> FileBuildSettings?
+    _ td: SwiftTargetBuildDescription) throws -> FileBuildSettings?
   {
     // FIXME: this is re-implementing llbuild's constructCommandLineArgs.
     var args: [String] = [
@@ -366,7 +378,7 @@ extension SwiftPMWorkspace {
     args += ["-c"]
     args += td.sources.map { $0.pathString }
     args += ["-I", buildPath.pathString]
-    args += td.compileArguments()
+    args += try td.compileArguments()
 
     return FileBuildSettings(
       compilerArguments: args,
@@ -380,11 +392,11 @@ extension SwiftPMWorkspace {
   public func settings(
     forClangFile path: AbsolutePath,
     _ language: Language,
-    _ td: ClangTargetBuildDescription) -> FileBuildSettings?
+    _ td: ClangTargetBuildDescription) throws -> FileBuildSettings?
   {
     // FIXME: this is re-implementing things from swiftpm's createClangCompileTarget
 
-    var args = td.basicArguments()
+    var args = try td.basicArguments()
 
     let nativePath: AbsolutePath =
         URL(fileURLWithPath: path.pathString).withUnsafeFileSystemRepresentation {
@@ -454,12 +466,13 @@ private func findPackageDirectory(
   return path
 }
 
-extension TSCBasic.Diagnostic.Behavior {
+extension Basics.Diagnostic.Severity {
   var asLogLevel: LogLevel {
     switch self {
     case .error: return .error
     case .warning: return .warning
-    default: return .info
+    case .debug: return .debug
+    case .info: return .info
     }
   }
 }

Tests/SKSwiftPMWorkspaceTests/SwiftPMWorkspaceTests.swift

@@ -110,7 +110,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
       XCTAssertEqual(ws.buildPath, build)
       XCTAssertNotNil(ws.indexStorePath)
-      let arguments = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let arguments = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
 
       check(
         "-module-name", "lib", "-incremental", "-emit-dependencies",
@@ -165,7 +165,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
       let build = buildPath(root: packageRoot, config: config, triple: hostTriple)
 
       XCTAssertEqual(ws.buildPath, build)
-      let arguments = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let arguments = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
 
       check("-typecheck", arguments: arguments)
       check("-Xcc", "-m32", arguments: arguments)
@@ -195,7 +195,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         buildSetup: TestSourceKitServer.serverOptions.buildSetup)
 
       let source = resolveSymlinks(packageRoot.appending(component: "Package.swift"))
-      let arguments = ws.settings(for: source.asURI, .swift)!.compilerArguments
+      let arguments = try ws.settings(for: source.asURI, .swift)!.compilerArguments
 
       check("-swift-version", "4.2", arguments: arguments)
       check(source.pathString, arguments: arguments)
@@ -227,10 +227,10 @@ final class SwiftPMWorkspaceTests: XCTestCase {
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
       let bswift = packageRoot.appending(components: "Sources", "lib", "b.swift")
 
-      let argumentsA = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let argumentsA = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
       check(aswift.pathString, arguments: argumentsA)
       check(bswift.pathString, arguments: argumentsA)
-      let argumentsB = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let argumentsB = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
       check(aswift.pathString, arguments: argumentsB)
       check(bswift.pathString, arguments: argumentsB)
     }
@@ -266,7 +266,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
       let aswift = packageRoot.appending(components: "Sources", "libA", "a.swift")
       let bswift = packageRoot.appending(components: "Sources", "libB", "b.swift")
-      let arguments = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let arguments = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
       check(aswift.pathString, arguments: arguments)
       checkNot(bswift.pathString, arguments: arguments)
       // Temporary conditional to work around revlock between SourceKit-LSP and SwiftPM
@@ -282,7 +282,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
           arguments: arguments)
       }
 
-      let argumentsB = ws.settings(for: bswift.asURI, .swift)!.compilerArguments
+      let argumentsB = try ws.settings(for: bswift.asURI, .swift)!.compilerArguments
       check(bswift.pathString, arguments: argumentsB)
       checkNot(aswift.pathString, arguments: argumentsB)
       checkNot("-I", packageRoot.appending(components: "Sources", "libC", "include").pathString,
@@ -316,9 +316,9 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
       let aswift = packageRoot.appending(components: "Sources", "libA", "a.swift")
       let bswift = packageRoot.appending(components: "Sources", "libB", "b.swift")
-      XCTAssertNotNil(ws.settings(for: aswift.asURI, .swift))
-      XCTAssertNil(ws.settings(for: bswift.asURI, .swift))
-      XCTAssertNil(ws.settings(for: DocumentURI(URL(string: "https://www.apple.com")!), .swift))
+      XCTAssertNotNil(try ws.settings(for: aswift.asURI, .swift))
+      XCTAssertNil(try ws.settings(for: bswift.asURI, .swift))
+      XCTAssertNil(try ws.settings(for: DocumentURI(URL(string: "https://www.apple.com")!), .swift))
     }
   }
 
@@ -375,7 +375,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         checkNot(bcxx.pathString, arguments: arguments)
       }
 
-      let args = ws.settings(for: acxx.asURI, .cpp)!.compilerArguments
+      let args = try ws.settings(for: acxx.asURI, .cpp)!.compilerArguments
       checkArgsCommon(args)
 
       URL(fileURLWithPath: build.appending(components: "lib.build", "a.cpp.d").pathString)
@@ -393,7 +393,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
       }
 
       let header = packageRoot.appending(components: "Sources", "lib", "include", "a.h")
-      let headerArgs = ws.settings(for: header.asURI, .cpp)!.compilerArguments
+      let headerArgs = try ws.settings(for: header.asURI, .cpp)!.compilerArguments
       checkArgsCommon(headerArgs)
 
       check("-c", "-x", "c++-header", URL(fileURLWithPath: header.pathString).path,
@@ -424,7 +424,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         buildSetup: TestSourceKitServer.serverOptions.buildSetup)
 
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
-      let arguments = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let arguments = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
       check("-target", arguments: arguments) // Only one!
       let hostTriple = ws.buildParameters.triple
 
@@ -469,16 +469,16 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         .appending(components: "Sources", "lib", "a.swift")
       let manifest = packageRoot.appending(components: "Package.swift")
 
-      let arguments1 = ws.settings(for: aswift1.asURI, .swift)?.compilerArguments
-      let arguments2 = ws.settings(for: aswift2.asURI, .swift)?.compilerArguments
+      let arguments1 = try ws.settings(for: aswift1.asURI, .swift)?.compilerArguments
+      let arguments2 = try ws.settings(for: aswift2.asURI, .swift)?.compilerArguments
       XCTAssertNotNil(arguments1)
       XCTAssertNotNil(arguments2)
       XCTAssertEqual(arguments1, arguments2)
 
       checkNot(aswift1.pathString, arguments: arguments1 ?? [])
       check(resolveSymlinks(aswift1).pathString, arguments: arguments1 ?? [])
 
-      let argsManifest = ws.settings(for: manifest.asURI, .swift)?.compilerArguments
+      let argsManifest = try ws.settings(for: manifest.asURI, .swift)?.compilerArguments
       XCTAssertNotNil(argsManifest)
 
       checkNot(manifest.pathString, arguments: argsManifest ?? [])
@@ -519,12 +519,12 @@ final class SwiftPMWorkspaceTests: XCTestCase {
       let acxx = packageRoot.appending(components: "Sources", "lib", "a.cpp")
       let ah = packageRoot.appending(components: "Sources", "lib", "include", "a.h")
 
-      let argsCxx = ws.settings(for: acxx.asURI, .cpp)?.compilerArguments
+      let argsCxx = try ws.settings(for: acxx.asURI, .cpp)?.compilerArguments
       XCTAssertNotNil(argsCxx)
       check(acxx.pathString, arguments: argsCxx ?? [])
       checkNot(resolveSymlinks(acxx).pathString, arguments: argsCxx ?? [])
 
-      let argsH = ws.settings(for: ah.asURI, .cpp)?.compilerArguments
+      let argsH = try ws.settings(for: ah.asURI, .cpp)?.compilerArguments
       XCTAssertNotNil(argsH)
       checkNot(ah.pathString, arguments: argsH ?? [])
       check(resolveSymlinks(ah).pathString, arguments: argsH ?? [])
@@ -558,7 +558,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
         buildSetup: TestSourceKitServer.serverOptions.buildSetup)
 
       let aswift = packageRoot.appending(components: "Sources", "lib", "a.swift")
-      let arguments = ws.settings(for: aswift.asURI, .swift)!.compilerArguments
+      let arguments = try ws.settings(for: aswift.asURI, .swift)!.compilerArguments
       check(aswift.pathString, arguments: arguments)
       XCTAssertNotNil(arguments.firstIndex(where: {
           $0.hasSuffix(".swift") && $0.contains("DerivedSources")