Merge branch 'main' into release/6.0

Author: ahoppen

Sources/Diagnose/DiagnoseCommand.swift

@@ -134,6 +134,7 @@ public struct DiagnoseCommand: AsyncParsableCommand {
 
     for crashInfo in crashInfos {
       let dateFormatter = DateFormatter()
+      dateFormatter.timeZone = NSTimeZone.local
       dateFormatter.dateStyle = .none
       dateFormatter.timeStyle = .medium
       let progressMessagePrefix = "Reducing Swift compiler crash at \(dateFormatter.string(from: crashInfo.date))"
@@ -304,7 +305,9 @@ public struct DiagnoseCommand: AsyncParsableCommand {
 
     progressBar = PercentProgressAnimation(stream: stderrStream, header: "Diagnosing sourcekit-lsp issues")
 
-    let date = ISO8601DateFormatter().string(from: Date()).replacingOccurrences(of: ":", with: "-")
+    let dateFormatter = ISO8601DateFormatter()
+    dateFormatter.timeZone = NSTimeZone.local
+    let date = dateFormatter.string(from: Date()).replacingOccurrences(of: ":", with: "-")
     let bundlePath = FileManager.default.temporaryDirectory
       .appendingPathComponent("sourcekitd-reproducer-\(date)")
     try FileManager.default.createDirectory(at: bundlePath, withIntermediateDirectories: true)
@@ -330,9 +333,9 @@ public struct DiagnoseCommand: AsyncParsableCommand {
     print(
       """
 
-      Bundle created. 
-      When filing an issue at https://github.com/apple/sourcekit-lsp/issues/new, 
-      please attach the bundle located at 
+      Bundle created.
+      When filing an issue at https://github.com/apple/sourcekit-lsp/issues/new,
+      please attach the bundle located at
       \(bundlePath.path)
       """
     )

Sources/Diagnose/SwiftFrontendCrashScraper.swift

@@ -70,6 +70,7 @@ struct SwiftFrontendCrashScraper {
       }
       let interestingString = fileContents[firstNewline...]
       let dateFormatter = DateFormatter()
+      dateFormatter.timeZone = NSTimeZone.local
       dateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSSS Z"
       let decoder = JSONDecoder()
       decoder.dateDecodingStrategy = .formatted(dateFormatter)

Sources/LSPLogging/NonDarwinLogging.swift

@@ -245,7 +245,8 @@ public struct NonDarwinLogMessage: ExpressibleByStringInterpolation, Expressible
 /// a new `DateFormatter` is rather expensive and its the same for all loggers.
 private let dateFormatter = {
   let dateFormatter = DateFormatter()
-  dateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS"
+  dateFormatter.timeZone = NSTimeZone.local
+  dateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSSS Z"
   return dateFormatter
 }()
 
@@ -299,11 +300,20 @@ public struct NonDarwinLogger: Sendable {
     guard level >= self.logLevel else { return }
     let date = Date()
     loggingQueue.async {
+      // Truncate log message after 10.000 characters to avoid flooding the log with huge log messages (eg. from a
+      // sourcekitd response). 10.000 characters was chosen because it seems to fit the result of most sourcekitd
+      // responses that are not generated interface or global completion results (which are a lot bigger).
+      var message = message().value.string(for: self.privacyLevel)
+      if message.utf8.count > 10_000 {
+        // Check for UTF-8 byte length first because that's faster since it doesn't need to count UTF-8 characters.
+        // Truncate using `.prefix` to avoid cutting of in the middle of a UTF-8 multi-byte character.
+        message = message.prefix(10_000) + "..."
+      }
       // Start each log message with `[org.swift.sourcekit-lsp` so that it’s easy to split the log to the different messages
       logHandler(
         """
         [\(subsystem):\(category)] \(level) \(dateFormatter.string(from: date))
-        \(message().value.string(for: self.privacyLevel))
+        \(message)
         ---
         """
       )

Sources/LanguageServerProtocol/Requests/OpenInterfaceRequest.swift

@@ -23,27 +23,24 @@ public struct OpenInterfaceRequest: TextDocumentRequest, Hashable {
   public var moduleName: String
 
   /// The module group name.
-  public var groupNames: [String]
+  public var groupName: String?
 
   /// The symbol USR to search for in the generated module interface.
   public var symbolUSR: String?
 
-  public init(textDocument: TextDocumentIdentifier, name: String, symbolUSR: String?) {
+  public init(textDocument: TextDocumentIdentifier, name: String, groupName: String?, symbolUSR: String?) {
     self.textDocument = textDocument
     self.symbolUSR = symbolUSR
-    // Stdlib Swift modules are all in the "Swift" module, but their symbols return a module name `Swift.***`.
-    let splitName = name.split(separator: ".")
-    self.moduleName = String(splitName[0])
-    self.groupNames = [String.SubSequence](splitName.dropFirst()).map(String.init)
+    self.moduleName = name
+    self.groupName = groupName
   }
 
   /// Name of interface module name with group names appended
   public var name: String {
-    if groupNames.count > 0 {
-      return "\(self.moduleName).\(self.groupNames.joined(separator: "."))"
-    } else {
-      return self.moduleName
+    if let groupName {
+      return "\(self.moduleName).\(groupName.replacing("/", with: "."))"
     }
+    return self.moduleName
   }
 }
 

Sources/LanguageServerProtocol/Requests/SymbolInfoRequest.swift

@@ -48,6 +48,18 @@ public struct SymbolInfoRequest: TextDocumentRequest, Hashable {
 /// Detailed information about a symbol, such as the response to a `SymbolInfoRequest`
 /// **(LSP Extension)**.
 public struct SymbolDetails: ResponseType, Hashable {
+  public struct ModuleInfo: Codable, Hashable, Sendable {
+    /// The name of the module in which the symbol is defined.
+    public let moduleName: String
+
+    /// If the symbol is defined within a subgroup of a module, the name of the group. Otherwise `nil`.
+    public let groupName: String?
+
+    public init(moduleName: String, groupName: String? = nil) {
+      self.moduleName = moduleName
+      self.groupName = groupName
+    }
+  }
 
   /// The name of the symbol, if any.
   public var name: String?
@@ -87,6 +99,11 @@ public struct SymbolDetails: ResponseType, Hashable {
   /// Optional because `clangd` does not return whether a symbol is dynamic.
   public var isDynamic: Bool?
 
+  /// Whether this symbol is defined in the SDK or standard library.
+  ///
+  /// This property only applies to Swift symbols.
+  public var isSystem: Bool?
+
   /// If the symbol is dynamic, the USRs of the types that might be called.
   ///
   /// This is relevant in the following cases
@@ -112,21 +129,31 @@ public struct SymbolDetails: ResponseType, Hashable {
   /// `B` may be called dynamically.
   public var receiverUsrs: [String]?
 
+  /// If the symbol is defined in a module that doesn't have source information associated with it, the name and group
+  /// and group name that defines this symbol.
+  ///
+  /// This property only applies to Swift symbols.
+  public var systemModule: ModuleInfo?
+
   public init(
     name: String?,
     containerName: String?,
     usr: String?,
     bestLocalDeclaration: Location?,
     kind: SymbolKind?,
     isDynamic: Bool?,
-    receiverUsrs: [String]?
+    isSystem: Bool?,
+    receiverUsrs: [String]?,
+    systemModule: ModuleInfo?
   ) {
     self.name = name
     self.containerName = containerName
     self.usr = usr
     self.bestLocalDeclaration = bestLocalDeclaration
     self.kind = kind
     self.isDynamic = isDynamic
+    self.isSystem = isSystem
     self.receiverUsrs = receiverUsrs
+    self.systemModule = systemModule
   }
 }

Sources/LanguageServerProtocol/SupportTypes/TestItem.swift

@@ -39,6 +39,12 @@ public struct TestItem: ResponseType, Equatable {
   /// When `nil` the `label` is used.
   public let sortText: String?
 
+  /// Whether the test is disabled.
+  public let disabled: Bool
+
+  /// The type of test, eg. the testing framework that was used to declare the test.
+  public let style: String
+
   /// The location of the test item in the source code.
   public let location: Location
 
@@ -55,6 +61,8 @@ public struct TestItem: ResponseType, Equatable {
     label: String,
     description: String? = nil,
     sortText: String? = nil,
+    disabled: Bool,
+    style: String,
     location: Location,
     children: [TestItem],
     tags: [TestTag]
@@ -63,6 +71,8 @@ public struct TestItem: ResponseType, Equatable {
     self.label = label
     self.description = description
     self.sortText = sortText
+    self.disabled = disabled
+    self.style = style
     self.location = location
     self.children = children
     self.tags = tags

Sources/SKCore/BuildSystemManager.swift

@@ -45,10 +45,10 @@ public actor BuildSystemManager {
   let fallbackBuildSystem: FallbackBuildSystem?
 
   /// Provider of file to main file mappings.
-  var _mainFilesProvider: MainFilesProvider?
+  var mainFilesProvider: MainFilesProvider?
 
   /// Build system delegate that will receive notifications about setting changes, etc.
-  var _delegate: BuildSystemDelegate?
+  var delegate: BuildSystemDelegate?
 
   /// 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
@@ -71,7 +71,7 @@ public actor BuildSystemManager {
     precondition(!buildSystemHasDelegate)
     self.buildSystem = buildSystem
     self.fallbackBuildSystem = fallbackBuildSystem
-    self._mainFilesProvider = mainFilesProvider
+    self.mainFilesProvider = mainFilesProvider
     self.fallbackSettingsTimeout = fallbackSettingsTimeout
     await self.buildSystem?.setDelegate(self)
   }
@@ -82,21 +82,11 @@ public actor BuildSystemManager {
 }
 
 extension BuildSystemManager {
-  public var delegate: BuildSystemDelegate? {
-    get { _delegate }
-    set { _delegate = newValue }
-  }
-
   /// - Note: Needed so we can set the delegate from a different isolation context.
   public func setDelegate(_ delegate: BuildSystemDelegate?) {
     self.delegate = delegate
   }
 
-  public var mainFilesProvider: MainFilesProvider? {
-    get { _mainFilesProvider }
-    set { _mainFilesProvider = newValue }
-  }
-
   /// - Note: Needed so we can set the delegate from a different isolation context.
   public func setMainFilesProvider(_ mainFilesProvider: MainFilesProvider?) {
     self.mainFilesProvider = mainFilesProvider
@@ -204,15 +194,15 @@ extension BuildSystemManager: BuildSystemDelegate {
   public func fileBuildSettingsChanged(_ changedFiles: Set<DocumentURI>) async {
     let changedWatchedFiles = watchedFilesReferencing(mainFiles: changedFiles)
 
-    if !changedWatchedFiles.isEmpty, let delegate = self._delegate {
+    if !changedWatchedFiles.isEmpty, let delegate = self.delegate {
       await delegate.fileBuildSettingsChanged(changedWatchedFiles)
     }
   }
 
   public func filesDependenciesUpdated(_ changedFiles: Set<DocumentURI>) async {
     // Empty changes --> assume everything has changed.
     guard !changedFiles.isEmpty else {
-      if let delegate = self._delegate {
+      if let delegate = self.delegate {
         await delegate.filesDependenciesUpdated(changedFiles)
       }
       return
@@ -226,13 +216,13 @@ extension BuildSystemManager: BuildSystemDelegate {
   }
 
   public func buildTargetsChanged(_ changes: [BuildTargetEvent]) async {
-    if let delegate = self._delegate {
+    if let delegate = self.delegate {
       await delegate.buildTargetsChanged(changes)
     }
   }
 
   public func fileHandlingCapabilityChanged() async {
-    if let delegate = self._delegate {
+    if let delegate = self.delegate {
       await delegate.fileHandlingCapabilityChanged()
     }
   }

Sources/SKSupport/AsyncUtils.swift

@@ -76,6 +76,21 @@ public extension Task {
   }
 }
 
+public extension Task where Failure == Never {
+  /// Awaits the value of the result.
+  ///
+  /// If the current task is cancelled, this will cancel the subtask as well.
+  var valuePropagatingCancellation: Success {
+    get async {
+      await withTaskCancellationHandler {
+        return await self.value
+      } onCancel: {
+        self.cancel()
+      }
+    }
+  }
+}
+
 /// Allows the execution of a cancellable operation that returns the results
 /// via a completion handler.
 ///

Sources/SKTestSupport/SkipUnless.swift

@@ -232,6 +232,34 @@ public enum SkipUnless {
     }
   }
 
+  /// Checks whether the index contains a fix that prevents it from adding relations to non-indexed locals
+  /// (https://github.com/apple/swift/pull/72930).
+  public static func indexOnlyHasContainedByRelationsToIndexedDecls(
+    file: StaticString = #file,
+    line: UInt = #line
+  ) async throws {
+    return try await skipUnlessSupportedByToolchain(swiftVersion: SwiftVersion(6, 0), file: file, line: line) {
+      let project = try await IndexedSingleSwiftFileTestProject(
+        """
+        func foo() {}
+
+        func 1️⃣testFunc(x: String) {
+          let myVar = foo
+        }
+        """
+      )
+      let prepare = try await project.testClient.send(
+        CallHierarchyPrepareRequest(
+          textDocument: TextDocumentIdentifier(project.fileURI),
+          position: project.positions["1️⃣"]
+        )
+      )
+      let initialItem = try XCTUnwrap(prepare?.only)
+      let calls = try await project.testClient.send(CallHierarchyOutgoingCallsRequest(item: initialItem))
+      return calls != []
+    }
+  }
+
   public static func longTestsEnabled() throws {
     if let value = ProcessInfo.processInfo.environment["SKIP_LONG_TESTS"], value == "1" || value == "YES" {
       throw XCTSkip("Long tests disabled using the `SKIP_LONG_TESTS` environment variable")

Sources/SourceKitLSP/CMakeLists.txt

@@ -20,6 +20,10 @@ target_sources(SourceKitLSP PRIVATE
   Clang/ClangLanguageService.swift)
 target_sources(SourceKitLSP PRIVATE
   Swift/AdjustPositionToStartOfIdentifier.swift
+  Swift/CodeActions/ConvertIntegerLiteral.swift
+  Swift/CodeActions/SyntaxCodeActionProvider.swift
+  Swift/CodeActions/SyntaxCodeActions.swift
+  Swift/CodeActions/SyntaxRefactoringCodeActionProvider.swift
   Swift/CodeCompletion.swift
   Swift/CodeCompletionSession.swift
   Swift/CommentXML.swift
@@ -38,6 +42,7 @@ target_sources(SourceKitLSP PRIVATE
   Swift/SourceKitD+ResponseError.swift
   Swift/SwiftCommand.swift
   Swift/SwiftLanguageService.swift
+  Swift/SwiftTestingScanner.swift
   Swift/SymbolInfo.swift
   Swift/SyntaxHighlightingToken.swift
   Swift/SyntaxHighlightingTokens.swift

Sources/SourceKitLSP/SourceKitIndexDelegate.swift

@@ -12,6 +12,7 @@
 
 import Dispatch
 import IndexStoreDB
+import LSPLogging
 import SKCore
 import SKSupport
 
@@ -51,17 +52,18 @@ public actor SourceKitIndexDelegate: IndexDelegate {
   private func processCompleted(_ count: Int) {
     pendingUnitCount -= count
     if pendingUnitCount == 0 {
-      _indexChanged()
+      indexChanged()
     }
 
     if pendingUnitCount < 0 {
       assertionFailure("pendingUnitCount = \(pendingUnitCount) < 0")
       pendingUnitCount = 0
-      _indexChanged()
+      indexChanged()
     }
   }
 
-  func _indexChanged() {
+  private func indexChanged() {
+    logger.debug("IndexStoreDB changed")
     for callback in mainFilesChangedCallbacks {
       queue.async {
         await callback()