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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import LSPLogging
import LanguageServerProtocol
import SKCore
import SemanticIndex
import XCTest
struct ExpectedPreparation {
let targetID: String
let runDestinationID: String
/// A closure that will be executed when a preparation task starts.
/// This allows the artificial delay of a preparation task to force two preparation task to race.
let didStart: (() -> Void)?
/// A closure that will be executed when a preparation task finishes.
/// This allows the artificial delay of a preparation task to force two preparation task to race.
let didFinish: (() -> Void)?
internal init(
targetID: String,
runDestinationID: String,
didStart: (() -> Void)? = nil,
didFinish: (() -> Void)? = nil
) {
self.targetID = targetID
self.runDestinationID = runDestinationID
self.didStart = didStart
self.didFinish = didFinish
}
var configuredTarget: ConfiguredTarget {
return ConfiguredTarget(targetID: targetID, runDestinationID: runDestinationID)
}
}
struct ExpectedIndexStoreUpdate {
let sourceFileName: String
/// A closure that will be executed when a preparation task starts.
/// This allows the artificial delay of a preparation task to force two preparation task to race.
let didStart: (() -> Void)?
/// A closure that will be executed when a preparation task finishes.
/// This allows the artificial delay of a preparation task to force two preparation task to race.
let didFinish: (() -> Void)?
internal init(
sourceFileName: String,
didStart: (() -> Void)? = nil,
didFinish: (() -> Void)? = nil
) {
self.sourceFileName = sourceFileName
self.didStart = didStart
self.didFinish = didFinish
}
}
actor ExpectedIndexTaskTracker {
/// The targets we expect to be prepared. For targets within the same set, we don't care about the exact order.
private var expectedPreparations: [[ExpectedPreparation]]?
private var expectedIndexStoreUpdates: [[ExpectedIndexStoreUpdate]]?
/// Implicitly-unwrapped optional so we can reference `self` when creating `IndexTestHooks`.
/// `nonisolated(unsafe)` is fine because this is not modified after `testHooks` is created.
nonisolated(unsafe) var testHooks: IndexTestHooks!
init(
expectedPreparations: [[ExpectedPreparation]]? = nil,
expectedIndexStoreUpdates: [[ExpectedIndexStoreUpdate]]? = nil
) {
self.expectedPreparations = expectedPreparations
self.expectedIndexStoreUpdates = expectedIndexStoreUpdates
self.testHooks = IndexTestHooks(
preparationTaskDidStart: { [weak self] in
await self?.preparationTaskDidStart(taskDescription: $0)
},
preparationTaskDidFinish: { [weak self] in
await self?.preparationTaskDidFinish(taskDescription: $0)
},
updateIndexStoreTaskDidStart: { [weak self] in
await self?.updateIndexStoreTaskDidStart(taskDescription: $0)
},
updateIndexStoreTaskDidFinish: { [weak self] in
await self?.updateIndexStoreTaskDidFinish(taskDescription: $0)
}
)
}
func preparationTaskDidStart(taskDescription: PreparationTaskDescription) -> Void {
guard let expectedPreparations else {
return
}
if Task.isCancelled {
logger.debug("Ignoring preparation task start because task is cancelled: \(taskDescription.targetsToPrepare)")
return
}
guard let expectedTargetsToPrepare = expectedPreparations.first else {
return
}
for expectedPreparation in expectedTargetsToPrepare {
if taskDescription.targetsToPrepare.contains(expectedPreparation.configuredTarget) {
expectedPreparation.didStart?()
}
}
}
func preparationTaskDidFinish(taskDescription: PreparationTaskDescription) -> Void {
guard let expectedPreparations else {
return
}
if Task.isCancelled {
logger.debug("Ignoring preparation task finish because task is cancelled: \(taskDescription.targetsToPrepare)")
return
}
guard let expectedTargetsToPrepare = expectedPreparations.first else {
XCTFail("Didn't expect a preparation but received \(taskDescription.targetsToPrepare)")
return
}
guard Set(taskDescription.targetsToPrepare).isSubset(of: expectedTargetsToPrepare.map(\.configuredTarget)) else {
XCTFail("Received unexpected preparation of \(taskDescription.targetsToPrepare)")
return
}
var remainingExpectedTargetsToPrepare: [ExpectedPreparation] = []
for expectedPreparation in expectedTargetsToPrepare {
if taskDescription.targetsToPrepare.contains(expectedPreparation.configuredTarget) {
expectedPreparation.didFinish?()
} else {
remainingExpectedTargetsToPrepare.append(expectedPreparation)
}
}
if remainingExpectedTargetsToPrepare.isEmpty {
self.expectedPreparations!.remove(at: 0)
} else {
self.expectedPreparations![0] = remainingExpectedTargetsToPrepare
}
}
func updateIndexStoreTaskDidStart(taskDescription: UpdateIndexStoreTaskDescription) -> Void {
if Task.isCancelled {
logger.debug(
"""
Ignoring update indexstore start because task is cancelled: \
\(taskDescription.filesToIndex.map(\.file.sourceFile))
"""
)
return
}
guard let expectedFilesToIndex = expectedIndexStoreUpdates?.first else {
return
}
for expectedIndexStoreUpdate in expectedFilesToIndex {
if taskDescription.filesToIndex.contains(where: { $0.sourceFileName == expectedIndexStoreUpdate.sourceFileName })
{
expectedIndexStoreUpdate.didStart?()
}
}
}
func updateIndexStoreTaskDidFinish(taskDescription: UpdateIndexStoreTaskDescription) -> Void {
guard let expectedIndexStoreUpdates else {
return
}
if Task.isCancelled {
logger.debug(
"""
Ignoring update indexstore finish because task is cancelled: \
\(taskDescription.filesToIndex.map(\.file.sourceFile))
"""
)
return
}
guard let expectedFilesToIndex = expectedIndexStoreUpdates.first else {
XCTFail("Didn't expect an index store update but received \(taskDescription.filesToIndex.map(\.file.sourceFile))")
return
}
guard
Set(taskDescription.filesToIndex.map(\.sourceFileName)).isSubset(of: expectedFilesToIndex.map(\.sourceFileName))
else {
XCTFail("Received unexpected index store update of \(taskDescription.filesToIndex.map(\.file.sourceFile))")
return
}
var remainingExpectedFilesToIndex: [ExpectedIndexStoreUpdate] = []
for expectedIndexStoreUpdate in expectedFilesToIndex {
if taskDescription.filesToIndex.map(\.sourceFileName).contains(expectedIndexStoreUpdate.sourceFileName) {
expectedIndexStoreUpdate.didFinish?()
} else {
remainingExpectedFilesToIndex.append(expectedIndexStoreUpdate)
}
}
if remainingExpectedFilesToIndex.isEmpty {
self.expectedIndexStoreUpdates!.remove(at: 0)
} else {
self.expectedIndexStoreUpdates![0] = remainingExpectedFilesToIndex
}
}
nonisolated func keepAlive() {
withExtendedLifetime(self) { _ in }
}
deinit {
if let expectedPreparations = self.expectedPreparations {
XCTAssert(
expectedPreparations.isEmpty,
"ExpectedPreparationTracker destroyed with unfulfilled expected preparations: \(expectedPreparations)."
)
}
}
}
fileprivate extension FileAndTarget {
var sourceFileName: String? {
return self.file.sourceFile.fileURL?.lastPathComponent
}
}
|
