Dont expose isExtension on TestItem

Author: plemarquand

Sources/LanguageServerProtocol/SupportTypes/TestItem.swift

@@ -56,16 +56,12 @@ public struct TestItem: ResponseType, Equatable {
   /// Tags associated with this test item.
   public var tags: [TestTag]
 
-  /// Whether the `TestItem` is declared in an extension.
-  public var isExtension: Bool
-
   public init(
     id: String,
     label: String,
     description: String? = nil,
     sortText: String? = nil,
     disabled: Bool,
-    isExtension: Bool,
     style: String,
     location: Location,
     children: [TestItem],
@@ -76,7 +72,6 @@ public struct TestItem: ResponseType, Equatable {
     self.description = description
     self.sortText = sortText
     self.disabled = disabled
-    self.isExtension = isExtension
     self.style = style
     self.location = location
     self.children = children

Sources/SourceKitLSP/LanguageService.swift

@@ -200,7 +200,7 @@ public protocol LanguageService: AnyObject {
   /// This is used as a fallback to show the test cases in a file if the index for a given file is not up-to-date.
   ///
   /// A return value of `nil` indicates that this language service does not support syntactic test discovery.
-  func syntacticDocumentTests(for uri: DocumentURI, in workspace: Workspace) async throws -> [TestItem]?
+  func syntacticDocumentTests(for uri: DocumentURI, in workspace: Workspace) async throws -> [AnnotatedTestItem]?
 
   /// Crash the language server. Should be used for crash recovery testing only.
   func _crash() async

Sources/SourceKitLSP/Swift/SwiftTestingScanner.swift

@@ -163,9 +163,6 @@ final class SyntacticSwiftTestingTestScanner: SyntaxVisitor {
   /// This is the case when the scanner is looking for tests inside a disabled suite.
   private let allTestsDisabled: Bool
 
-  /// Whether the tests discovered by the scanner should be marked as being delcared in an extension.
-  private let isScanningExtension: Bool
-
   /// The names of the types that this scanner is scanning members for.
   ///
   /// For example, when scanning for tests inside `Bar` in the following, this is `["Foo", "Bar"]`
@@ -180,26 +177,24 @@ final class SyntacticSwiftTestingTestScanner: SyntaxVisitor {
   private let parentTypeNames: [String]
 
   /// The discovered test items.
-  private var result: [TestItem] = []
+  private var result: [AnnotatedTestItem] = []
 
   private init(
     snapshot: DocumentSnapshot,
     allTestsDisabled: Bool,
-    isScanningExtension: Bool,
     parentTypeNames: [String]
   ) {
     self.snapshot = snapshot
     self.allTestsDisabled = allTestsDisabled
     self.parentTypeNames = parentTypeNames
-    self.isScanningExtension = isScanningExtension
     super.init(viewMode: .fixedUp)
   }
 
   /// Public entry point. Scans the syntax tree of the given snapshot for swift-testing tests.
   public static func findTestSymbols(
     in snapshot: DocumentSnapshot,
     syntaxTreeManager: SyntaxTreeManager
-  ) async -> [TestItem] {
+  ) async -> [AnnotatedTestItem] {
     guard snapshot.text.contains("Suite") || snapshot.text.contains("Test") else {
       // If the file contains swift-testing tests, it must contain a `@Suite` or `@Test` attribute.
       // Only check for the attribute name because the attribute may be module qualified and contain an arbitrary amount
@@ -211,7 +206,6 @@ final class SyntacticSwiftTestingTestScanner: SyntaxVisitor {
     let visitor = SyntacticSwiftTestingTestScanner(
       snapshot: snapshot,
       allTestsDisabled: false,
-      isScanningExtension: false,
       parentTypeNames: []
     )
     visitor.walk(syntaxTree)
@@ -245,7 +239,6 @@ final class SyntacticSwiftTestingTestScanner: SyntaxVisitor {
     let memberScanner = SyntacticSwiftTestingTestScanner(
       snapshot: snapshot,
       allTestsDisabled: attributeData?.isDisabled ?? false,
-      isScanningExtension: node is ExtensionDeclSyntax,
       parentTypeNames: parentTypeNames + typeNames
     )
     memberScanner.walk(node.memberBlock)
@@ -256,15 +249,18 @@ final class SyntacticSwiftTestingTestScanner: SyntaxVisitor {
     }
 
     let range = snapshot.range(of: node.positionAfterSkippingLeadingTrivia..<node.endPositionBeforeTrailingTrivia)
-    let testItem = TestItem(
-      id: (parentTypeNames + typeNames).joined(separator: "/"),
-      label: attributeData?.displayName ?? typeNames.last!,
-      disabled: (attributeData?.isDisabled ?? false) || allTestsDisabled,
-      isExtension: node is ExtensionDeclSyntax,
-      style: TestStyle.swiftTesting,
-      location: Location(uri: snapshot.uri, range: range),
-      children: memberScanner.result,
-      tags: attributeData?.tags.map(TestTag.init(id:)) ?? []
+    // Members wont be extensions since extensions will only be at the top level.
+    let testItem = AnnotatedTestItem(
+      testItem: TestItem(
+        id: (parentTypeNames + typeNames).joined(separator: "/"),
+        label: attributeData?.displayName ?? typeNames.last!,
+        disabled: (attributeData?.isDisabled ?? false) || allTestsDisabled,
+        style: TestStyle.swiftTesting,
+        location: Location(uri: snapshot.uri, range: range),
+        children: memberScanner.result.map(\.testItem),
+        tags: attributeData?.tags.map(TestTag.init(id:)) ?? []
+      ),
+      isExtension: node.is(ExtensionDeclSyntax.self)
     )
     result.append(testItem)
     return .skipChildren
@@ -311,15 +307,17 @@ final class SyntacticSwiftTestingTestScanner: SyntaxVisitor {
       node.name.text + "(" + node.signature.parameterClause.parameters.map { "\($0.firstName.text):" }.joined() + ")"
 
     let range = snapshot.range(of: node.positionAfterSkippingLeadingTrivia..<node.endPositionBeforeTrailingTrivia)
-    let testItem = TestItem(
-      id: (parentTypeNames + [name]).joined(separator: "/"),
-      label: attributeData.displayName ?? name,
-      disabled: attributeData.isDisabled || allTestsDisabled,
-      isExtension: isScanningExtension,
-      style: TestStyle.swiftTesting,
-      location: Location(uri: snapshot.uri, range: range),
-      children: [],
-      tags: attributeData.tags.map(TestTag.init(id:))
+    let testItem = AnnotatedTestItem(
+      testItem: TestItem(
+        id: (parentTypeNames + [name]).joined(separator: "/"),
+        label: attributeData.displayName ?? name,
+        disabled: attributeData.isDisabled || allTestsDisabled,
+        style: TestStyle.swiftTesting,
+        location: Location(uri: snapshot.uri, range: range),
+        children: [],
+        tags: attributeData.tags.map(TestTag.init(id:))
+      ),
+      isExtension: false
     )
     result.append(testItem)
     return .visitChildren

Sources/SourceKitLSP/Swift/SyntacticTestIndex.swift

@@ -51,7 +51,7 @@ fileprivate enum TaskMetadata: DependencyTracker, Equatable {
 /// Data from a syntactic scan of a source file for tests.
 fileprivate struct IndexedTests {
   /// The tests within the source file.
-  let tests: [TestItem]
+  let tests: [AnnotatedTestItem]
 
   /// The modification date of the source file when it was scanned. A file won't get re-scanned if its modification date
   /// is older or the same as this date.
@@ -63,7 +63,7 @@ fileprivate struct IndexedTests {
 /// Does not write the results to the index.
 ///
 /// The order of the returned tests is not defined. The results should be sorted before being returned to the editor.
-fileprivate func testItems(in url: URL) async -> [TestItem] {
+fileprivate func testItems(in url: URL) async -> [AnnotatedTestItem] {
   guard url.pathExtension == "swift" else {
     return []
   }
@@ -79,6 +79,8 @@ fileprivate func testItems(in url: URL) async -> [TestItem] {
     syntaxTreeManager: syntaxTreeManager
   )
   async let xcTests = SyntacticSwiftXCTestScanner.findTestSymbols(in: snapshot, syntaxTreeManager: syntaxTreeManager)
+    .map { AnnotatedTestItem(testItem: $0, isExtension: false) }
+
   return await swiftTestingTests + xcTests
 }
 
@@ -206,7 +208,7 @@ actor SyntacticTestIndex {
   /// Gets all the tests in the syntactic index.
   ///
   /// This waits for any pending document updates to be indexed before returning a result.
-  nonisolated func tests() async -> [TestItem] {
+  nonisolated func tests() async -> [AnnotatedTestItem] {
     let readTask = indexingQueue.async(metadata: .read) {
       return await self.indexedTests.values.flatMap { $0.tests }
     }