Merge pull request #1103 from ahoppen/ahoppen/call-hierarchy-look-through-protocols

Show calls to satisfied protocol requirements in call hierarchy

Author: ahoppen

Sources/SourceKitLSP/SourceKitServer.swift

@@ -2086,7 +2086,14 @@ extension SourceKitServer {
     else {
       return []
     }
-    let callableUsrs = [data.usr] + index.occurrences(relatedToUSR: data.usr, roles: .accessorOf).map(\.symbol.usr)
+    var callableUsrs = [data.usr]
+    // Calls to the accessors of a property count as calls to the property
+    callableUsrs += index.occurrences(relatedToUSR: data.usr, roles: .accessorOf).map(\.symbol.usr)
+    // Also show calls to the functions that this method overrides. This includes overridden class methods and
+    // satisfied protocol requirements.
+    callableUsrs += index.occurrences(ofUSR: data.usr, roles: .overrideOf).flatMap { occurrence in
+      occurrence.relations.filter { $0.roles.contains(.overrideOf) }.map(\.symbol.usr)
+    }
     let callOccurrences = callableUsrs.flatMap { index.occurrences(ofUSR: $0, roles: .calledBy) }
     let calls = callOccurrences.flatMap { occurrence -> [CallHierarchyIncomingCall] in
       guard let location = indexToLSPLocation(occurrence.location) else {

Tests/SourceKitLSPTests/CallHierarchyTests.swift

@@ -447,4 +447,102 @@ final class CallHierarchyTests: XCTestCase {
       ]
     )
   }
+
+  func testIncomingCallHierarchyLooksThroughProtocols() async throws {
+    let ws = try await IndexedSingleSwiftFileWorkspace(
+      """
+      protocol MyProtocol {
+        func foo()
+      }
+      struct MyStruct: MyProtocol {
+        func 1️⃣foo() {}
+      }
+      struct Unrelated: MyProtocol {
+        func foo() {}
+      }
+      func 2️⃣test(proto: MyProtocol) {
+        proto.3️⃣foo()
+        Unrelated().foo() // should not be considered a call to MyStruct.foo
+      }
+      """
+    )
+    let prepare = try await ws.testClient.send(
+      CallHierarchyPrepareRequest(
+        textDocument: TextDocumentIdentifier(ws.fileURI),
+        position: ws.positions["1️⃣"]
+      )
+    )
+    let initialItem = try XCTUnwrap(prepare?.only)
+    let calls = try await ws.testClient.send(CallHierarchyIncomingCallsRequest(item: initialItem))
+    XCTAssertEqual(
+      calls,
+      [
+        CallHierarchyIncomingCall(
+          from: CallHierarchyItem(
+            name: "test(proto:)",
+            kind: .function,
+            tags: nil,
+            detail: "test",  // test is the module name because the file is called test.swift
+            uri: ws.fileURI,
+            range: Range(ws.positions["2️⃣"]),
+            selectionRange: Range(ws.positions["2️⃣"]),
+            data: .dictionary([
+              "usr": .string("s:4testAA5protoyAA10MyProtocol_p_tF"),
+              "uri": .string(ws.fileURI.stringValue),
+            ])
+          ),
+          fromRanges: [Range(ws.positions["3️⃣"])]
+        )
+      ]
+    )
+  }
+
+  func testIncomingCallHierarchyLooksThroughSuperclasses() async throws {
+    let ws = try await IndexedSingleSwiftFileWorkspace(
+      """
+      class Base {
+        func foo() {}
+      }
+      class Inherited: Base {
+        override func 1️⃣foo() {}
+      }
+      class Unrelated: Base {
+        override func foo() {}
+      }
+      func 2️⃣test(base: Base) {
+        base.3️⃣foo()
+        Unrelated().foo() // should not be considered a call to MyStruct.foo
+      }
+      """
+    )
+    let prepare = try await ws.testClient.send(
+      CallHierarchyPrepareRequest(
+        textDocument: TextDocumentIdentifier(ws.fileURI),
+        position: ws.positions["1️⃣"]
+      )
+    )
+    let initialItem = try XCTUnwrap(prepare?.only)
+    let calls = try await ws.testClient.send(CallHierarchyIncomingCallsRequest(item: initialItem))
+    XCTAssertEqual(
+      calls,
+      [
+        CallHierarchyIncomingCall(
+          from: CallHierarchyItem(
+            name: "test(base:)",
+            kind: .function,
+            tags: nil,
+            detail: "test",  // test is the module name because the file is called test.swift
+            uri: ws.fileURI,
+            range: Range(ws.positions["2️⃣"]),
+            selectionRange: Range(ws.positions["2️⃣"]),
+            data: .dictionary([
+              "usr": .string("s:4testAA4baseyAA4BaseC_tF"),
+              "uri": .string(ws.fileURI.stringValue),
+            ])
+          ),
+          fromRanges: [Range(ws.positions["3️⃣"])]
+        )
+      ]
+    )
+  }
 }