Merge pull request #1459 from ahoppen/testable-methods

Change methods that were only public for testing purposes to be `@_spi(Testing)`

Author: ahoppen

Sources/LanguageServerProtocolJSONRPC/MessageCoding.swift

@@ -12,8 +12,7 @@
 
 import LanguageServerProtocol
 
-/// *Public For Testing*. A single JSONRPC message suitable for encoding/decoding.
-public enum JSONRPCMessage {
+@_spi(Testing) public enum JSONRPCMessage {
   case notification(NotificationType)
   case request(_RequestType, id: RequestID)
   case response(ResponseType, id: RequestID)

Sources/SKCore/BuildSystemManager.swift

@@ -417,8 +417,10 @@ extension BuildSystemManager {
 
 extension BuildSystemManager {
 
-  /// *For Testing* Returns the main file used for `uri`, if this is a registered file.
-  public func _cachedMainFile(for uri: DocumentURI) -> DocumentURI? {
+  /// Returns the main file used for `uri`, if this is a registered file.
+  ///
+  /// For testing purposes only.
+  @_spi(Testing) public func cachedMainFile(for uri: DocumentURI) -> DocumentURI? {
     return self.watchedFiles[uri]?.mainFile
   }
 }

Sources/SKCore/ToolchainRegistry.swift

@@ -71,7 +71,7 @@ public final actor ToolchainRegistry {
 
   /// Create a toolchain registry with a pre-defined list of toolchains.
   ///
-  /// For testing purposes.
+  /// For testing purposes only.
   @_spi(Testing)
   public init(toolchains: [Toolchain]) {
     self.init(

Sources/SKCore/XCToolchainPlist.swift

@@ -105,7 +105,9 @@ extension XCToolchainPlist: Codable {
     self.displayName = try container.decodeIfPresent(String.self, forKey: .DisplayName)
   }
 
-  /// Encode the info plist. **For testing**.
+  /// Encode the info plist.
+  ///
+  /// For testing purposes only.
   public func encode(to encoder: Encoder) throws {
     var container = encoder.container(keyedBy: CodingKeys.self)
     if identifier.starts(with: "com.apple") {

Sources/SourceKitLSP/Clang/ClangLanguageService.swift

@@ -342,7 +342,7 @@ actor ClangLanguageService: LanguageService, MessageHandler {
     return nil
   }
 
-  func _crash() {
+  func crash() {
     // Since `clangd` doesn't have a method to crash it, kill it.
     #if os(Windows)
     if self.hClangd != INVALID_HANDLE_VALUE {

Sources/SourceKitLSP/LanguageService.swift

@@ -237,5 +237,5 @@ public protocol LanguageService: AnyObject, Sendable {
   func canonicalDeclarationPosition(of position: Position, in uri: DocumentURI) async -> Position?
 
   /// Crash the language server. Should be used for crash recovery testing only.
-  func _crash() async
+  func crash() async
 }

Sources/SourceKitLSP/SourceKitIndexDelegate.swift

@@ -18,9 +18,7 @@ import SKSupport
 import SwiftExtensions
 
 /// `IndexDelegate` for the SourceKit workspace.
-///
-/// *Public for testing*.
-public actor SourceKitIndexDelegate: IndexDelegate {
+actor SourceKitIndexDelegate: IndexDelegate {
 
   let queue = AsyncQueue<Serial>()
 

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -112,7 +112,7 @@ public actor SourceKitLSPServer {
 
   var languageServices: [LanguageServerType: [LanguageService]] = [:]
 
-  let documentManager = DocumentManager()
+  @_spi(Testing) public let documentManager = DocumentManager()
 
   /// The `TaskScheduler` that schedules all background indexing tasks.
   ///
@@ -131,11 +131,6 @@ public actor SourceKitLSPServer {
   private var inProgressPackageLoadingOperations = 0
   private var packageLoadingWorkDoneProgress: WorkDoneProgressManager?
 
-  /// **Public for testing**
-  public var _documentManager: DocumentManager {
-    return documentManager
-  }
-
   /// Caches which workspace a document with the given URI should be opened in.
   ///
   /// - Important: Must only be modified from `workspaceQueue`. This means that the value of `uriToWorkspaceCache`
@@ -495,16 +490,7 @@ public actor SourceKitLSPServer {
     }
   }
 
-  /// **Public for testing purposes only**
-  public func _languageService(
-    for uri: DocumentURI,
-    _ language: Language,
-    in workspace: Workspace
-  ) async -> LanguageService? {
-    return await languageService(for: uri, language, in: workspace)
-  }
-
-  func languageService(
+  @_spi(Testing) public func languageService(
     for uri: DocumentURI,
     _ language: Language,
     in workspace: Workspace

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -230,7 +230,7 @@ public actor SwiftLanguageService: LanguageService, Sendable {
   }
 
   /// - Important: For testing only
-  public func setReusedNodeCallback(_ callback: (@Sendable (_ node: Syntax) -> ())?) async {
+  @_spi(Testing) public func setReusedNodeCallback(_ callback: (@Sendable (_ node: Syntax) -> ())?) async {
     await self.syntaxTreeManager.setReusedNodeCallback(callback)
   }
 
@@ -340,7 +340,7 @@ extension SwiftLanguageService {
   }
 
   /// Tell sourcekitd to crash itself. For testing purposes only.
-  public func _crash() async {
+  public func crash() async {
     let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.crashWithExit
     ])

Sources/SourceKitLSP/Swift/SyntaxHighlightingTokenParser.swift

@@ -205,7 +205,7 @@ struct SyntaxHighlightingTokenParser {
 
 extension Range<Position> {
   /// Splits a potentially multi-line range to multiple single-line ranges.
-  func splitToSingleLineRanges(in snapshot: DocumentSnapshot) -> [Self] {
+  @_spi(Testing) public func splitToSingleLineRanges(in snapshot: DocumentSnapshot) -> [Self] {
     if isEmpty {
       return []
     }
@@ -234,9 +234,4 @@ extension Range<Position> {
       }
       .filter { !$0.isEmpty }
   }
-
-  /// **Public for testing**
-  public func _splitToSingleLineRanges(in snapshot: DocumentSnapshot) -> [Self] {
-    splitToSingleLineRanges(in: snapshot)
-  }
 }