sourcekit-lsp/Sources/SourceKitLSP/TestHooks.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#if compiler(>=6)
package import BuildSystemIntegration
import Foundation
package import LanguageServerProtocol
import LanguageServerProtocolExtensions
package import SemanticIndex

import struct TSCBasic.AbsolutePath
import struct TSCBasic.RelativePath
#else
import BuildSystemIntegration
import Foundation
import LanguageServerProtocol
import LanguageServerProtocolExtensions
import SemanticIndex

import struct TSCBasic.AbsolutePath
import struct TSCBasic.RelativePath
#endif

/// Closures can be used to inspect or modify internal behavior in SourceKit-LSP.
public struct TestHooks: Sendable {
  package var indexTestHooks: IndexTestHooks

  package var buildSystemTestHooks: BuildSystemTestHooks

  /// A hook that will be executed before a request is handled.
  ///
  /// This allows requests to be artificially delayed.
  package var handleRequest: (@Sendable (any RequestType) async -> Void)?

  public init() {
    self.init(indexTestHooks: IndexTestHooks(), buildSystemTestHooks: BuildSystemTestHooks(), handleRequest: nil)
  }

  package init(
    indexTestHooks: IndexTestHooks = IndexTestHooks(),
    buildSystemTestHooks: BuildSystemTestHooks = BuildSystemTestHooks(),
    handleRequest: (@Sendable (any RequestType) async -> Void)? = nil
  ) {
    self.indexTestHooks = indexTestHooks
    self.buildSystemTestHooks = buildSystemTestHooks
    self.handleRequest = handleRequest
  }
}