Files
sourcekit-lsp/Sources/SourceKitLSP/SourceKitLSPServer+Options.swift
Alex Hoppen 37e6a8a65a Wait for cancellation to propagate in testDontReturnEmptyDiagnosticsIfDiagnosticRequestIsCancelled
I saw a few non-deterministic test failures. I think the issue was that handling of the `CancelRequestNotification` is done asynchronously, which left a short window in which the sourcekitd diagnostics request could run and return results instead of being cancelled. Wait for the diagnostic request to actually be cancelled before running it for real.

While doing this, also introduce proper sourcekitd test hooks instead of relying on the preparation test hooks, which just got run as a side effect.
2024-06-04 11:34:11 -07:00

84 lines
3.3 KiB
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
//
//===----------------------------------------------------------------------===//
import Foundation
import LanguageServerProtocol
import SKCore
import SKSupport
import SemanticIndex
import SourceKitD
import struct TSCBasic.AbsolutePath
import struct TSCBasic.RelativePath
extension SourceKitLSPServer {
/// Configuration options for the SourceKitServer.
public struct Options: Sendable {
/// Additional compiler flags (e.g. `-Xswiftc` for SwiftPM projects) and other build-related
/// configuration.
public var buildSetup: BuildSetup
/// Additional arguments to pass to `clangd` on the command-line.
public var clangdOptions: [String]
/// Additional paths to search for a compilation database, relative to a workspace root.
public var compilationDatabaseSearchPaths: [RelativePath]
/// Additional options for the index.
public var indexOptions: IndexOptions
/// Options for code-completion.
public var completionOptions: SKCompletionOptions
/// Override the default directory where generated interfaces will be stored
public var generatedInterfacesPath: AbsolutePath
/// The time that `SwiftLanguageService` should wait after an edit before starting to compute diagnostics and
/// sending a `PublishDiagnosticsNotification`.
///
/// This is mostly intended for testing purposes so we don't need to wait the debouncing time to get a diagnostics
/// notification when running unit tests.
public var swiftPublishDiagnosticsDebounceDuration: TimeInterval
/// Experimental features that are enabled.
public var experimentalFeatures: Set<ExperimentalFeature>
public var sourcekitdTestHooks: SourceKitDTestHooks
public var indexTestHooks: IndexTestHooks
public init(
buildSetup: BuildSetup = .default,
clangdOptions: [String] = [],
compilationDatabaseSearchPaths: [RelativePath] = [],
indexOptions: IndexOptions = .init(),
completionOptions: SKCompletionOptions = .init(),
generatedInterfacesPath: AbsolutePath = defaultDirectoryForGeneratedInterfaces,
swiftPublishDiagnosticsDebounceDuration: TimeInterval = 2, /* 2s */
experimentalFeatures: Set<ExperimentalFeature> = [],
sourcekitdTestHooks: SourceKitDTestHooks = SourceKitDTestHooks(),
indexTestHooks: IndexTestHooks = IndexTestHooks()
) {
self.buildSetup = buildSetup
self.clangdOptions = clangdOptions
self.compilationDatabaseSearchPaths = compilationDatabaseSearchPaths
self.indexOptions = indexOptions
self.completionOptions = completionOptions
self.generatedInterfacesPath = generatedInterfacesPath
self.swiftPublishDiagnosticsDebounceDuration = swiftPublishDiagnosticsDebounceDuration
self.experimentalFeatures = experimentalFeatures
self.sourcekitdTestHooks = sourcekitdTestHooks
self.indexTestHooks = indexTestHooks
}
}
}