Files
sourcekit-lsp/Sources/SemanticIndex/IndexTestHooks.swift
Alex Hoppen 2877675bd5 Adopt package access level
Change a l public declarations to the `package` access level, accept for:
- The `LanguageServerProtocol` module
- The `BuildServerProtocol` module
- `InProcessClient.InProcessSourceKitLSPClient`
- `LanguageServerProtocolJSONRPC` (I would like to create a more ergonomic API for this like `InProcessSourceKitLSPClient` in the future, but for now, we’ll leave it public)

Unfortunately, our pattern of marking functions as `@_spi(Testing) public` no longer works with the `package` access level because declarations at the `package` access level cannot be marked as SPI. I have decided to just mark these functions as `package`. Alternatives would be:
- Add an underscore to these functions, like we did for functions exposed for testing before the introduction of `SPI`
- Use `@testable` import in the test targets and mark the methods as `internal`

Resolves #1315
rdar://128295618
2024-07-19 09:54:30 -07:00

44 lines
2.2 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 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
//
//===----------------------------------------------------------------------===//
/// Callbacks that allow inspection of internal state modifications during testing.
package struct IndexTestHooks: Sendable {
package var buildGraphGenerationDidStart: (@Sendable () async -> Void)?
package var buildGraphGenerationDidFinish: (@Sendable () async -> Void)?
package var preparationTaskDidStart: (@Sendable (PreparationTaskDescription) async -> Void)?
package var preparationTaskDidFinish: (@Sendable (PreparationTaskDescription) async -> Void)?
package var updateIndexStoreTaskDidStart: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)?
/// A callback that is called when an index task finishes.
package var updateIndexStoreTaskDidFinish: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)?
package init(
buildGraphGenerationDidStart: (@Sendable () async -> Void)? = nil,
buildGraphGenerationDidFinish: (@Sendable () async -> Void)? = nil,
preparationTaskDidStart: (@Sendable (PreparationTaskDescription) async -> Void)? = nil,
preparationTaskDidFinish: (@Sendable (PreparationTaskDescription) async -> Void)? = nil,
updateIndexStoreTaskDidStart: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)? = nil,
updateIndexStoreTaskDidFinish: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)? = nil
) {
self.buildGraphGenerationDidStart = buildGraphGenerationDidStart
self.buildGraphGenerationDidFinish = buildGraphGenerationDidFinish
self.preparationTaskDidStart = preparationTaskDidStart
self.preparationTaskDidFinish = preparationTaskDidFinish
self.updateIndexStoreTaskDidStart = updateIndexStoreTaskDidStart
self.updateIndexStoreTaskDidFinish = updateIndexStoreTaskDidFinish
}
}