Merge pull request #1213 from ahoppen/6.0/merge-main-2024-05-01

Merge `main` into `release/6.0`

Author: ahoppen

Package.swift

@@ -309,6 +309,7 @@ let package = Package(
         .product(name: "SwiftRefactor", package: "swift-syntax"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+        .product(name: "SwiftPM-auto", package: "swift-package-manager"),
       ],
       exclude: ["CMakeLists.txt"]
     ),

Sources/LanguageServerProtocol/SupportTypes/VersionedTextDocumentIdentifier.swift

@@ -53,4 +53,18 @@ public struct OptionalVersionedTextDocumentIdentifier: Hashable, Codable, Sendab
     self.uri = uri
     self.version = version
   }
+
+  enum CodingKeys: CodingKey {
+    case uri
+    case version
+  }
+
+  public func encode(to encoder: any Encoder) throws {
+    var container = encoder.container(keyedBy: CodingKeys.self)
+    try container.encode(self.uri, forKey: .uri)
+
+    // Note: we use encode(_:forKey:) here instead of encodeIf(_:forKey:)
+    // because VSCode will drop requests without the explicit 'null'.
+    try container.encode(self.version, forKey: .version)
+  }
 }

Sources/SKSwiftPMWorkspace/SwiftPMBuildSystem.swift

@@ -263,7 +263,7 @@ extension SwiftPMBuildSystem {
     self.fileToTarget = [AbsolutePath: SwiftBuildTarget](
       modulesGraph.allTargets.flatMap { target in
         return target.sources.paths.compactMap {
-          guard let buildTarget = buildDescription.getBuildTarget(for: target) else {
+          guard let buildTarget = buildDescription.getBuildTarget(for: target, in: modulesGraph) else {
             return nil
           }
           return (key: $0, value: buildTarget)
@@ -277,7 +277,7 @@ extension SwiftPMBuildSystem {
 
     self.sourceDirToTarget = [AbsolutePath: SwiftBuildTarget](
       modulesGraph.allTargets.compactMap { (target) -> (AbsolutePath, SwiftBuildTarget)? in
-        guard let buildTarget = buildDescription.getBuildTarget(for: target) else {
+        guard let buildTarget = buildDescription.getBuildTarget(for: target, in: modulesGraph) else {
           return nil
         }
         return (key: target.sources.root, value: buildTarget)
@@ -439,8 +439,13 @@ extension SwiftPMBuildSystem: SKCore.BuildSystem {
   }
 
   public func testFiles() -> [DocumentURI] {
-    // We should only include source files from test targets (https://github.com/apple/sourcekit-lsp/issues/1174).
-    return fileToTarget.map { DocumentURI($0.key.asURL) }
+    return fileToTarget.compactMap { (path, target) -> DocumentURI? in
+      guard target.isPartOfRootPackage else {
+        // Don't consider files from package dependencies as possible test files.
+        return nil
+      }
+      return DocumentURI(path.asURL)
+    }
   }
 
   public func addTestFilesDidChangeCallback(_ callback: @Sendable @escaping () async -> Void) async {

Sources/SKTestSupport/MultiFileTestProject.swift

@@ -31,6 +31,15 @@ public struct RelativeFileLocation: Hashable, ExpressibleByStringLiteral {
     let components = value.components(separatedBy: "/")
     self.init(directories: components.dropLast(), components.last!)
   }
+
+  public func url(relativeTo: URL) -> URL {
+    var url = relativeTo
+    for directory in directories {
+      url = url.appendingPathComponent(directory)
+    }
+    url = url.appendingPathComponent(fileName)
+    return url
+  }
 }
 
 /// A test project that writes multiple files to disk and opens a `TestSourceKitLSPClient` client with a workspace
@@ -69,7 +78,7 @@ public class MultiFileTestProject {
   /// File contents can also contain `$TEST_DIR`, which gets replaced by the temporary directory.
   public init(
     files: [RelativeFileLocation: String],
-    workspaces: (URL) -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
+    workspaces: (URL) async throws -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
     usePullDiagnostics: Bool = true,
     testName: String = #function
   ) async throws {
@@ -79,11 +88,7 @@ public class MultiFileTestProject {
     var fileData: [String: FileData] = [:]
     for (fileLocation, markedText) in files {
       let markedText = markedText.replacingOccurrences(of: "$TEST_DIR", with: scratchDirectory.path)
-      var fileURL = scratchDirectory
-      for directory in fileLocation.directories {
-        fileURL = fileURL.appendingPathComponent(directory)
-      }
-      fileURL = fileURL.appendingPathComponent(fileLocation.fileName)
+      let fileURL = fileLocation.url(relativeTo: scratchDirectory)
       try FileManager.default.createDirectory(
         at: fileURL.deletingLastPathComponent(),
         withIntermediateDirectories: true

Sources/SKTestSupport/SwiftPMDependencyProject.swift

@@ -0,0 +1,108 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 Foundation
+import ISDBTibs
+import XCTest
+
+import struct TSCBasic.AbsolutePath
+import class TSCBasic.Process
+import enum TSCBasic.ProcessEnv
+import struct TSCBasic.ProcessResult
+
+/// A SwiftPM package that gets written to disk and for which a Git repository is initialized with a commit tagged
+/// `1.0.0`. This repository can then be used as a dependency for another package, usually a `SwiftPMTestProject`.
+public class SwiftPMDependencyProject {
+  /// The directory in which the repository lives.
+  public let packageDirectory: URL
+
+  private func runCommand(_ toolName: String, _ arguments: [String], workingDirectory: URL) async throws {
+    enum Error: Swift.Error {
+      case cannotFindTool(toolName: String)
+      case processedTerminatedWithNonZeroExitCode(ProcessResult)
+    }
+    guard let toolUrl = findTool(name: toolName) else {
+      if ProcessEnv.block["SWIFTCI_USE_LOCAL_DEPS"] == nil {
+        // Never skip the test in CI, similar to what SkipUnless does.
+        throw XCTSkip("\(toolName) cannot be found")
+      }
+      throw Error.cannotFindTool(toolName: toolName)
+    }
+    print([toolUrl.path] + arguments)
+    let process = TSCBasic.Process(
+      arguments: [toolUrl.path] + arguments,
+      workingDirectory: try AbsolutePath(validating: workingDirectory.path)
+    )
+    try process.launch()
+    let processResult = try await process.waitUntilExit()
+    guard processResult.exitStatus == .terminated(code: 0) else {
+      throw Error.processedTerminatedWithNonZeroExitCode(processResult)
+    }
+  }
+
+  public static let defaultPackageManifest: String = """
+    // swift-tools-version: 5.7
+
+    import PackageDescription
+
+    let package = Package(
+      name: "MyDependency",
+      products: [.library(name: "MyDependency", targets: ["MyDependency"])],
+      targets: [.target(name: "MyDependency")]
+    )
+    """
+
+  public init(
+    files: [RelativeFileLocation: String],
+    manifest: String = defaultPackageManifest,
+    testName: String = #function
+  ) async throws {
+    packageDirectory = try testScratchDir(testName: testName).appendingPathComponent("MyDependency")
+
+    var files = files
+    files["Package.swift"] = manifest
+
+    for (fileLocation, contents) in files {
+      let fileURL = fileLocation.url(relativeTo: packageDirectory)
+      try FileManager.default.createDirectory(
+        at: fileURL.deletingLastPathComponent(),
+        withIntermediateDirectories: true
+      )
+      try contents.write(to: fileURL, atomically: true, encoding: .utf8)
+    }
+
+    try await runCommand("git", ["init"], workingDirectory: packageDirectory)
+    try await runCommand(
+      "git",
+      ["add"] + files.keys.map { $0.url(relativeTo: packageDirectory).path },
+      workingDirectory: packageDirectory
+    )
+    try await runCommand(
+      "git",
+      ["-c", "user.name=Dummy", "-c", "[email protected]", "commit", "-m", "Initial commit"],
+      workingDirectory: packageDirectory
+    )
+    try await runCommand("git", ["tag", "1.0.0"], workingDirectory: packageDirectory)
+  }
+
+  deinit {
+    if cleanScratchDirectories {
+      try? FileManager.default.removeItem(at: packageDirectory)
+    }
+  }
+
+  /// Function that makes sure the project stays alive until this is called. Otherwise, the `SwiftPMDependencyProject`
+  /// might get deinitialized, which deletes the package on disk.
+  public func keepAlive() {
+    withExtendedLifetime(self) { _ in }
+  }
+}

Sources/SKTestSupport/SwiftPMTestProject.swift

@@ -38,7 +38,7 @@ public class SwiftPMTestProject: MultiFileTestProject {
   public init(
     files: [RelativeFileLocation: String],
     manifest: String = SwiftPMTestProject.defaultPackageManifest,
-    workspaces: (URL) -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
+    workspaces: (URL) async throws -> [WorkspaceFolder] = { [WorkspaceFolder(uri: DocumentURI($0))] },
     build: Bool = false,
     allowBuildFailure: Bool = false,
     usePullDiagnostics: Bool = true,
@@ -59,6 +59,7 @@ public class SwiftPMTestProject: MultiFileTestProject {
       filesByPath[RelativeFileLocation(directories: directories, fileLocation.fileName)] = contents
     }
     filesByPath["Package.swift"] = manifest
+
     try await super.init(
       files: filesByPath,
       workspaces: workspaces,
@@ -96,4 +97,18 @@ public class SwiftPMTestProject: MultiFileTestProject {
     environment["SWIFTPM_ENABLE_CLANG_INDEX_STORE"] = "1"
     try await Process.checkNonZeroExit(arguments: arguments, environmentBlock: environment)
   }
+
+  /// Resolve package dependencies for the package at `path`.
+  public static func resolvePackageDependencies(at path: URL) async throws {
+    guard let swift = await ToolchainRegistry.forTesting.default?.swift?.asURL else {
+      throw Error.swiftNotFound
+    }
+    let arguments = [
+      swift.path,
+      "package",
+      "resolve",
+      "--package-path", path.path,
+    ]
+    try await Process.checkNonZeroExit(arguments: arguments)
+  }
 }

Sources/SourceKitLSP/CMakeLists.txt

@@ -23,6 +23,7 @@ target_sources(SourceKitLSP PRIVATE
 target_sources(SourceKitLSP PRIVATE
   Swift/AdjustPositionToStartOfIdentifier.swift
   Swift/CodeActions/ConvertIntegerLiteral.swift
+  Swift/CodeActions/PackageManifestEdits.swift
   Swift/CodeActions/SyntaxCodeActionProvider.swift
   Swift/CodeActions/SyntaxCodeActions.swift
   Swift/CodeActions/SyntaxRefactoringCodeActionProvider.swift
@@ -74,5 +75,6 @@ target_link_libraries(SourceKitLSP PUBLIC
   SwiftSyntax::SwiftRefactor
   SwiftSyntax::SwiftSyntax)
 target_link_libraries(SourceKitLSP PRIVATE
+  PackageModelSyntax
   $<$<NOT:$<PLATFORM_ID:Darwin>>:FoundationXML>)
 

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -821,7 +821,7 @@ public actor SourceKitLSPServer {
       return nil
     }
 
-    logger.info("Using toolchain \(toolchain.displayName) (\(toolchain.identifier)) for \(uri.forLogging)")
+    logger.log("Using toolchain \(toolchain.displayName) (\(toolchain.identifier)) for \(uri.forLogging)")
 
     if let concurrentlySetService = workspace.documentService[uri] {
       // Since we await the construction of `service`, another call to this