Add some logging for testRecomputeFileWorkspaceMembershipOnPackageSwiftChange

I just saw a failure of this test in CI, and can’t figure out what might have happened. Adding some logging that hopefully helps us if the failure happens again.

Author: ahoppen

Package.swift

@@ -305,8 +305,20 @@ let package = Package(
     .testTarget(
       name: "SourceKitLSPTests",
       dependencies: [
+        "BuildServerProtocol",
+        "LSPLogging",
+        "LSPTestSupport",
+        "LanguageServerProtocol",
+        "SKCore",
+        "SKSupport",
         "SKTestSupport",
+        "SourceKitD",
         "SourceKitLSP",
+        .product(name: "IndexStoreDB", package: "indexstore-db"),
+        .product(name: "ISDBTestSupport", package: "indexstore-db"),
+        .product(name: "SwiftParser", package: "swift-syntax"),
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ]
     ),
   ]

Sources/LSPLogging/Logging.swift

@@ -15,7 +15,9 @@
 ///  - Info: Helpful but not essential for troubleshooting (not persisted, logged to memory)
 ///  - Notice/log (Default): Essential for troubleshooting
 ///  - Error: Error seen during execution
+///    - Used eg. if the user sends an erroneous request or if a request fails
 ///  - Fault: Bug in program
+///    - Used eg. if invariants inside sourcekit-lsp are broken and the error is not due to user-provided input
 
 import Foundation
 

Sources/SKSwiftPMWorkspace/SwiftPMWorkspace.swift

@@ -363,6 +363,7 @@ extension SwiftPMWorkspace: SKCore.BuildSystem {
 
   public func filesDidChange(_ events: [FileEvent]) async {
     if events.contains(where: { self.fileEventShouldTriggerPackageReload(event: $0) }) {
+      logger.log("Reloading package because of file change")
       await orLog("Reloading package") {
         // TODO: It should not be necessary to reload the entire package just to get build settings for one file.
         try await self.reloadPackage()

Sources/SourceKitLSP/SourceKitServer.swift

@@ -1051,6 +1051,7 @@ extension SourceKitServer: BuildSystemDelegate {
   }
 
   public func fileHandlingCapabilityChanged() {
+    logger.log("Resetting URI to workspace cache because file handling capability of a workspace changed")
     self.uriToWorkspaceCache = [:]
   }
 }

Tests/SourceKitLSPTests/WorkspaceTests.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
+import LSPLogging
 import LSPTestSupport
 import LanguageServerProtocol
 @_spi(Testing) import SKCore
@@ -457,7 +458,7 @@ final class WorkspaceTests: XCTestCase {
       DocumentURI(ws.scratchDirectory.appendingPathComponent("PackageA"))
     )
 
-    // Add the otherlib target to Package.swift
+    // Add the MyExec target to PackageB/Package.swift
     let newPackageManifest = """
       // swift-tools-version: 5.7
 
@@ -477,7 +478,7 @@ final class WorkspaceTests: XCTestCase {
       .appendingPathComponent("Package.swift")
     try newPackageManifest.write(
       to: packageBManifestPath,
-      atomically: false,
+      atomically: true,
       encoding: .utf8
     )
 
@@ -490,7 +491,7 @@ final class WorkspaceTests: XCTestCase {
     // Ensure that the DidChangeWatchedFilesNotification is handled before we continue.
     _ = try await ws.testClient.send(BarrierRequest())
 
-    // After updating Package.swift in PackageB, PackageB can provide proper build settings for MyExec/main.swift and
+    // After updating PackageB/Package.swift, PackageB can provide proper build settings for MyExec/main.swift and
     // thus workspace membership should switch to PackageB.
 
     // Updating the build settings takes a few seconds. Send code completion requests every second until we receive correct results.
@@ -499,10 +500,12 @@ final class WorkspaceTests: XCTestCase {
     // Updating the build settings takes a few seconds. Send code completion requests every second until we receive correct results.
     let packageBRootUri = DocumentURI(ws.scratchDirectory.appendingPathComponent("PackageB"))
     for _ in 0..<30 {
-      if await ws.testClient.server.workspaceForDocument(uri: mainUri)?.rootUri == packageBRootUri {
+      let workspace = await ws.testClient.server.workspaceForDocument(uri: mainUri)
+      if workspace?.rootUri == packageBRootUri {
         didReceiveCorrectWorkspaceMembership = true
         break
       }
+      logger.log("Received incorrect workspace \(workspace?.rootUri?.pseudoPath ?? "<nil>"). Trying again in 1s")
       try await Task.sleep(nanoseconds: 1_000_000_000)
     }