Merge pull request #1718 from ahoppen/swift-5.10-again

Make SourceKit-LSP build using a Swift 5.10 compiler again

Author: ahoppen

Contributor Documentation/README.md

@@ -8,4 +8,5 @@ The following documentation documents are primarily intended for developers of S
 - [Logging](Logging.md)
 - [Modules](Modules.md)
 - [Overview](Overview.md)
+- [Swift Version](Swift%20Version.md)
 - [Testing](Testing.md)

Contributor Documentation/Swift Version.md

@@ -0,0 +1,3 @@
+# Swift Version
+
+SourceKit-LSP currently needs to be able to build and pass tests using a Swift 5.10 compiler.

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -468,22 +468,22 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
       } else {
         nil
       }
-    self.cachedSourceKitOptions.clear { cacheKey in
+    self.cachedSourceKitOptions.clear(isolation: self) { cacheKey in
       guard let updatedTargets else {
         // All targets might have changed
         return true
       }
       return updatedTargets.contains(cacheKey.target)
     }
-    self.cachedBuildTargets.clearAll()
-    self.cachedTargetSources.clear { cacheKey in
+    self.cachedBuildTargets.clearAll(isolation: self)
+    self.cachedTargetSources.clear(isolation: self) { cacheKey in
       guard let updatedTargets else {
         // All targets might have changed
         return true
       }
       return !updatedTargets.intersection(cacheKey.targets).isEmpty
     }
-    self.cachedSourceFilesAndDirectories.clearAll()
+    self.cachedSourceFilesAndDirectories.clearAll(isolation: self)
 
     await delegate?.buildTargetsChanged(notification.changes)
     await delegate?.fileBuildSettingsChanged(Set(watchedFiles.keys))
@@ -680,7 +680,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
     // For now, this should be fine because all build systems return
     // very quickly from `settings(for:language:)`.
     // https://github.com/apple/sourcekit-lsp/issues/1181
-    let response = try await cachedSourceKitOptions.get(request) { request in
+    let response = try await cachedSourceKitOptions.get(request, isolation: self) { request in
       try await buildSystemAdapter.send(request)
     }
     guard let response else {
@@ -873,7 +873,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
     }
 
     let request = WorkspaceBuildTargetsRequest()
-    let result = try await cachedBuildTargets.get(request) { request in
+    let result = try await cachedBuildTargets.get(request, isolation: self) { request in
       let buildTargets = try await buildSystemAdapter.send(request).targets
       let (depths, dependents) = await self.targetDepthsAndDependents(for: buildTargets)
       var result: [BuildTargetIdentifier: BuildTargetInfo] = [:]
@@ -917,7 +917,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
 
     // If we have a cached request for a superset of the targets, serve the result from that cache entry.
     let fromSuperset = await orLog("Getting source files from superset request") {
-      try await cachedTargetSources.get { request in
+      try await cachedTargetSources.get(isolation: self) { request in
         targets.isSubset(of: request.targets)
       } transform: { response in
         return BuildTargetSourcesResponse(items: response.items.filter { targets.contains($0.target) })
@@ -928,7 +928,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
     }
 
     let request = BuildTargetSourcesRequest(targets: targets.sorted { $0.uri.stringValue < $1.uri.stringValue })
-    let response = try await cachedTargetSources.get(request) { request in
+    let response = try await cachedTargetSources.get(request, isolation: self) { request in
       try await buildSystemAdapter.send(request)
     }
     return response.items
@@ -959,7 +959,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
       sourcesItems: sourcesItems
     )
 
-    return try await cachedSourceFilesAndDirectories.get(key) { key in
+    return try await cachedSourceFilesAndDirectories.get(key, isolation: self) { key in
       var files: [DocumentURI: SourceFileInfo] = [:]
       var directories: [DocumentURI: SourceFileInfo] = [:]
       for sourcesItem in key.sourcesItems {

Sources/BuildSystemIntegration/SwiftPMBuildSystem.swift

@@ -448,7 +448,23 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
 
       throw NonFileURIError(uri: file)
     }
-    return try buildTarget.compileArguments(for: fileURL)
+    let compileArguments = try buildTarget.compileArguments(for: fileURL)
+
+    #if compiler(>=6.1)
+    #warning("When we drop support for Swift 5.10 we no longer need to adjust compiler arguments for the Modules move")
+    #endif
+    // Fix up compiler arguments that point to a `/Modules` subdirectory if the Swift version in the toolchain is less
+    // than 6.0 because it places the modules one level higher up.
+    let toolchainVersion = await orLog("Getting Swift version") { try await toolchain.swiftVersion }
+    guard let toolchainVersion, toolchainVersion < SwiftVersion(6, 0) else {
+      return compileArguments
+    }
+    return compileArguments.map { argument in
+      if argument.hasSuffix("/Modules"), argument.contains(self.swiftPMWorkspace.location.scratchDirectory.pathString) {
+        return String(argument.dropLast(8))
+      }
+      return argument
+    }
   }
 
   package func buildTargets(request: WorkspaceBuildTargetsRequest) async throws -> WorkspaceBuildTargetsResponse {

Sources/SKLogging/Logging.swift

@@ -19,9 +19,15 @@ package typealias LogLevel = os.OSLogType
 package typealias Logger = os.Logger
 package typealias Signposter = OSSignposter
 
+#if compiler(<5.11)
+extension OSSignposter: @unchecked Sendable {}
+extension OSSignpostID: @unchecked Sendable {}
+extension OSSignpostIntervalState: @unchecked Sendable {}
+#else
 extension OSSignposter: @retroactive @unchecked Sendable {}
 extension OSSignpostID: @retroactive @unchecked Sendable {}
 extension OSSignpostIntervalState: @retroactive @unchecked Sendable {}
+#endif
 
 extension os.Logger {
   package func makeSignposter() -> Signposter {