Merge pull request #1915 from ahoppen/diags-from-symlinks

Return diagnostics if SwiftPM project is opened from a symlinked URL

Author: ahoppen

Sources/SourceKitLSP/Swift/Diagnostic.swift

@@ -17,6 +17,7 @@ import LanguageServerProtocolExtensions
 import SKLogging
 import SourceKitD
 import SwiftDiagnostics
+import SwiftExtensions
 import SwiftSyntax
 
 extension CodeAction {
@@ -154,7 +155,6 @@ fileprivate extension String {
 }
 
 extension Diagnostic {
-
   /// Creates a diagnostic from a sourcekitd response dictionary.
   ///
   /// `snapshot` is the snapshot of the document for which the diagnostics are generated.
@@ -172,7 +172,22 @@ extension Diagnostic {
       logger.fault("Missing file path in diagnostic")
       return nil
     }
-    guard filePath == snapshot.uri.pseudoPath else {
+
+    func haveSameRealpath(_ lhs: DocumentURI, _ rhs: DocumentURI) -> Bool {
+      guard let lhsFileURL = lhs.fileURL, let rhsFileURL = rhs.fileURL else {
+        return false
+      }
+      do {
+        return try lhsFileURL.realpath == rhsFileURL.realpath
+      } catch {
+        return false
+      }
+    }
+
+    guard
+      filePath == snapshot.uri.pseudoPath
+        || haveSameRealpath(DocumentURI(filePath: filePath, isDirectory: false), snapshot.uri)
+    else {
       logger.error("Ignoring diagnostic from a different file: \(filePath)")
       return nil
     }

Tests/SourceKitLSPTests/PullDiagnosticsTests.swift

@@ -431,4 +431,39 @@ final class PullDiagnosticsTests: XCTestCase {
       ]
     )
   }
+
+  func testDiagnosticsWhenOpeningProjectFromSymlink() async throws {
+    let contents = """
+      let x: String = 1
+      """
+    let project = try await SwiftPMTestProject(
+      files: ["FileA.swift": contents],
+      workspaces: { scratchDirectory in
+        let symlinkUrl = scratchDirectory.appendingPathComponent("symlink")
+        try FileManager.default.createSymbolicLink(
+          at: symlinkUrl,
+          withDestinationURL: scratchDirectory
+        )
+        return [WorkspaceFolder(uri: DocumentURI(symlinkUrl))]
+      }
+    )
+
+    let uri = DocumentURI(
+      project.scratchDirectory
+        .appendingPathComponent("symlink")
+        .appendingPathComponent("Sources")
+        .appendingPathComponent("MyLibrary")
+        .appendingPathComponent("FileA.swift")
+    )
+    project.testClient.send(
+      DidOpenTextDocumentNotification(
+        textDocument: TextDocumentItem(uri: uri, language: .swift, version: 0, text: contents)
+      )
+    )
+    let diagnostics = try await project.testClient.send(
+      DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
+    )
+    let diagnostic = try XCTUnwrap(diagnostics.fullReport?.items.only)
+    XCTAssertEqual(diagnostic.message, "Cannot convert value of type 'Int' to specified type 'String'")
+  }
 }