1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
//===----------------------------------------------------------------------===//
//
// 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 LanguageServerProtocolExtensions
import SKLogging
import SKOptions
import SwiftExtensions
extension WorkDoneProgressManager {
init?(
server: SourceKitLSPServer,
capabilityRegistry: CapabilityRegistry?,
tokenPrefix: String,
initialDebounce: Duration? = nil,
title: String,
message: String? = nil,
percentage: Int? = nil
) {
guard let capabilityRegistry, capabilityRegistry.clientCapabilities.window?.workDoneProgress ?? false else {
return nil
}
self.init(
connectionToClient: server.client,
waitUntilClientInitialized: { [weak server] in await server?.waitUntilInitialized() },
tokenPrefix: tokenPrefix,
initialDebounce: initialDebounce,
title: title,
message: message,
percentage: percentage
)
}
}
/// A `WorkDoneProgressManager` that essentially has two states. If any operation tracked by this type is currently
/// running, it displays a work done progress in the client. If multiple operations are running at the same time, it
/// doesn't show multiple work done progress in the client. For example, we only want to show one progress indicator
/// when sourcekitd has crashed, not one per `SwiftLanguageService`.
actor SharedWorkDoneProgressManager {
private weak var sourceKitLSPServer: SourceKitLSPServer?
/// The number of in-progress operations. When greater than 0 `workDoneProgress` is non-nil and a work done progress
/// is displayed to the user.
private var inProgressOperations = 0
private var workDoneProgress: WorkDoneProgressManager?
private let tokenPrefix: String
private let title: String
private let message: String?
package init(
sourceKitLSPServer: SourceKitLSPServer,
tokenPrefix: String,
title: String,
message: String? = nil
) {
self.sourceKitLSPServer = sourceKitLSPServer
self.tokenPrefix = tokenPrefix
self.title = title
self.message = message
}
func start() async {
guard let sourceKitLSPServer else {
return
}
// Do all asynchronous operations up-front so that incrementing `inProgressOperations` and setting `workDoneProgress`
// cannot be interrupted by an `await` call
let initialDebounceDuration = await sourceKitLSPServer.options.workDoneProgressDebounceDurationOrDefault
let capabilityRegistry = await sourceKitLSPServer.capabilityRegistry
inProgressOperations += 1
if let capabilityRegistry, workDoneProgress == nil {
workDoneProgress = WorkDoneProgressManager(
server: sourceKitLSPServer,
capabilityRegistry: capabilityRegistry,
tokenPrefix: tokenPrefix,
initialDebounce: initialDebounceDuration,
title: title,
message: message
)
}
}
func end() async {
if inProgressOperations > 0 {
inProgressOperations -= 1
} else {
logger.fault(
"Unbalanced calls to SharedWorkDoneProgressManager.start and end for \(self.tokenPrefix, privacy: .public)"
)
}
if inProgressOperations == 0, let workDoneProgress {
self.workDoneProgress = nil
await workDoneProgress.end()
}
}
}
|
