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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import PackageModel
import PackageLoading
@testable import PackageRegistry
import SPMTestSupport
import XCTest
import class TSCBasic.InMemoryFileSystem
import struct TSCUtility.Version
class RegistryDownloadsManagerTests: XCTestCase {
func testNoCache() async throws {
let observability = ObservabilitySystem.makeForTesting()
let fs = InMemoryFileSystem()
let registry = MockRegistry(
filesystem: fs,
identityResolver: DefaultIdentityResolver(),
checksumAlgorithm: MockHashAlgorithm(),
fingerprintStorage: MockPackageFingerprintStorage(),
signingEntityStorage: MockPackageSigningEntityStorage()
)
let package: PackageIdentity = .plain("test.\(UUID().uuidString)")
let packageVersion: Version = "1.0.0"
let packageSource = InMemoryRegistryPackageSource(fileSystem: fs, path: .root.appending(components: "registry", "server", package.description))
try packageSource.writePackageContent()
registry.addPackage(
identity: package,
versions: [packageVersion],
source: packageSource
)
let delegate = MockRegistryDownloadsManagerDelegate()
let downloadsPath = AbsolutePath.root.appending(components: "registry", "downloads")
let manager = RegistryDownloadsManager(
fileSystem: fs,
path: downloadsPath,
cachePath: .none, // cache disabled
registryClient: registry.registryClient,
delegate: delegate
)
// try to get a package
do {
delegate.prepare(fetchExpected: true)
let path = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertEqual(path, try downloadsPath.appending(package.downloadPath(version: packageVersion)))
XCTAssertTrue(fs.isDirectory(path))
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.count, 1)
XCTAssertEqual(delegate.willFetch.first?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(delegate.willFetch.first?.fetchDetails, .init(fromCache: false, updatedCache: false))
XCTAssertEqual(delegate.didFetch.count, 1)
XCTAssertEqual(delegate.didFetch.first?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(try! delegate.didFetch.first?.result.get(), .init(fromCache: false, updatedCache: false))
}
// try to get a package that does not exist
let unknownPackage: PackageIdentity = .plain("unknown.\(UUID().uuidString)")
let unknownPackageVersion: Version = "1.0.0"
do {
delegate.prepare(fetchExpected: true)
await XCTAssertAsyncThrowsError(try await manager.lookup(package: unknownPackage, version: unknownPackageVersion, observabilityScope: observability.topScope)) { error in
XCTAssertNotNil(error as? RegistryError)
}
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.map { ($0.packageVersion) },
[
(PackageVersion(package: package, version: packageVersion)),
(PackageVersion(package: unknownPackage, version: unknownPackageVersion))
]
)
XCTAssertEqual(delegate.didFetch.map { ($0.packageVersion) },
[
(PackageVersion(package: package, version: packageVersion)),
(PackageVersion(package: unknownPackage, version: unknownPackageVersion))
]
)
}
// try to get the existing package again, no fetching expected this time
do {
delegate.prepare(fetchExpected: false)
let path = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertEqual(path, try downloadsPath.appending(package.downloadPath(version: packageVersion)))
XCTAssertTrue(fs.isDirectory(path))
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.map { ($0.packageVersion) },
[
(PackageVersion(package: package, version: packageVersion)),
(PackageVersion(package: unknownPackage, version: unknownPackageVersion))
]
)
XCTAssertEqual(delegate.didFetch.map { ($0.packageVersion) },
[
(PackageVersion(package: package, version: packageVersion)),
(PackageVersion(package: unknownPackage, version: unknownPackageVersion))
]
)
}
// remove the package
do {
try manager.remove(package: package)
delegate.prepare(fetchExpected: true)
let path = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertEqual(path, try downloadsPath.appending(package.downloadPath(version: packageVersion)))
XCTAssertTrue(fs.isDirectory(path))
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.map { ($0.packageVersion) },
[
(PackageVersion(package: package, version: packageVersion)),
(PackageVersion(package: unknownPackage, version: unknownPackageVersion)),
(PackageVersion(package: package, version: packageVersion))
]
)
XCTAssertEqual(delegate.didFetch.map { ($0.packageVersion) },
[
(PackageVersion(package: package, version: packageVersion)),
(PackageVersion(package: unknownPackage, version: unknownPackageVersion)),
(PackageVersion(package: package, version: packageVersion))
]
)
}
}
func testCache() async throws {
let observability = ObservabilitySystem.makeForTesting()
let fs = InMemoryFileSystem()
let registry = MockRegistry(
filesystem: fs,
identityResolver: DefaultIdentityResolver(),
checksumAlgorithm: MockHashAlgorithm(),
fingerprintStorage: MockPackageFingerprintStorage(),
signingEntityStorage: MockPackageSigningEntityStorage()
)
let package: PackageIdentity = .plain("test.\(UUID().uuidString)")
let packageVersion: Version = "1.0.0"
let packageSource = InMemoryRegistryPackageSource(fileSystem: fs, path: .root.appending(components: "registry", "server", package.description))
try packageSource.writePackageContent()
registry.addPackage(
identity: package,
versions: [packageVersion],
source: packageSource
)
let delegate = MockRegistryDownloadsManagerDelegate()
let downloadsPath = AbsolutePath.root.appending(components: "registry", "downloads")
let cachePath = AbsolutePath.root.appending(components: "registry", "cache")
let manager = RegistryDownloadsManager(
fileSystem: fs,
path: downloadsPath,
cachePath: cachePath, // cache enabled
registryClient: registry.registryClient,
delegate: delegate
)
// try to get a package
do {
delegate.prepare(fetchExpected: true)
let path = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertEqual(path, try downloadsPath.appending(package.downloadPath(version: packageVersion)))
XCTAssertTrue(fs.isDirectory(path))
XCTAssertTrue(fs.isDirectory(cachePath.appending(components: package.registry!.scope.description, package.registry!.name.description, packageVersion.description)))
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.count, 1)
XCTAssertEqual(delegate.willFetch.first?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(delegate.willFetch.first?.fetchDetails, .init(fromCache: false, updatedCache: false))
XCTAssertEqual(delegate.didFetch.count, 1)
XCTAssertEqual(delegate.didFetch.first?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(try! delegate.didFetch.first?.result.get(), .init(fromCache: true, updatedCache: true))
}
// remove the "local" package, should come from cache
do {
try manager.remove(package: package)
delegate.prepare(fetchExpected: true)
let path = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertEqual(path, try downloadsPath.appending(package.downloadPath(version: packageVersion)))
XCTAssertTrue(fs.isDirectory(path))
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.count, 2)
XCTAssertEqual(delegate.willFetch.last?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(delegate.willFetch.last?.fetchDetails, .init(fromCache: true, updatedCache: false))
XCTAssertEqual(delegate.didFetch.count, 2)
XCTAssertEqual(delegate.didFetch.last?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(try! delegate.didFetch.last?.result.get(), .init(fromCache: true, updatedCache: false))
}
// remove the "local" package, and purge cache
do {
try manager.remove(package: package)
manager.purgeCache(observabilityScope: observability.topScope)
delegate.prepare(fetchExpected: true)
let path = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope)
XCTAssertNoDiagnostics(observability.diagnostics)
XCTAssertEqual(path, try downloadsPath.appending(package.downloadPath(version: packageVersion)))
XCTAssertTrue(fs.isDirectory(path))
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.count, 3)
XCTAssertEqual(delegate.willFetch.last?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(delegate.willFetch.last?.fetchDetails, .init(fromCache: false, updatedCache: false))
XCTAssertEqual(delegate.didFetch.count, 3)
XCTAssertEqual(delegate.didFetch.last?.packageVersion, .init(package: package, version: packageVersion))
XCTAssertEqual(try! delegate.didFetch.last?.result.get(), .init(fromCache: true, updatedCache: true))
}
}
func testConcurrency() async throws {
let observability = ObservabilitySystem.makeForTesting()
let fs = InMemoryFileSystem()
let registry = MockRegistry(
filesystem: fs,
identityResolver: DefaultIdentityResolver(),
checksumAlgorithm: MockHashAlgorithm(),
fingerprintStorage: MockPackageFingerprintStorage(),
signingEntityStorage: MockPackageSigningEntityStorage()
)
let downloadsPath = AbsolutePath.root.appending(components: "registry", "downloads")
let delegate = MockRegistryDownloadsManagerDelegate()
let manager = RegistryDownloadsManager(
fileSystem: fs,
path: downloadsPath,
cachePath: .none, // cache disabled
registryClient: registry.registryClient,
delegate: delegate
)
// many different versions
do {
let concurrency = 100
let package: PackageIdentity = .plain("test.\(UUID().uuidString)")
let packageVersions = (0 ..< concurrency).map { Version($0, 0 , 0) }
let packageSource = InMemoryRegistryPackageSource(fileSystem: fs, path: .root.appending(components: "registry", "server", package.description))
try packageSource.writePackageContent()
registry.addPackage(
identity: package,
versions: packageVersions,
source: packageSource
)
let results = ThreadSafeKeyValueStore<Version, AbsolutePath>()
try await withThrowingTaskGroup(of: Void.self) { group in
for packageVersion in packageVersions {
group.addTask {
delegate.prepare(fetchExpected: true)
results[packageVersion] = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope, delegateQueue: .sharedConcurrent, callbackQueue: .sharedConcurrent)
}
}
try await group.waitForAll()
}
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.count, concurrency)
XCTAssertEqual(delegate.didFetch.count, concurrency)
XCTAssertEqual(results.count, concurrency)
for packageVersion in packageVersions {
let expectedPath = try downloadsPath.appending(package.downloadPath(version: packageVersion))
XCTAssertEqual(results[packageVersion], expectedPath)
}
}
// same versions
do {
let concurrency = 1000
let repeatRatio = 10
let package: PackageIdentity = .plain("test.\(UUID().uuidString)")
let packageVersions = (0 ..< concurrency / 10).map { Version($0, 0 , 0) }
let packageSource = InMemoryRegistryPackageSource(fileSystem: fs, path: .root.appending(components: "registry", "server", package.description))
try packageSource.writePackageContent()
registry.addPackage(
identity: package,
versions: packageVersions,
source: packageSource
)
delegate.reset()
let results = ThreadSafeKeyValueStore<Version, AbsolutePath>()
try await withThrowingTaskGroup(of: Void.self) { group in
for index in 0 ..< concurrency {
group.addTask {
delegate.prepare(fetchExpected: index < concurrency / repeatRatio)
let packageVersion = Version(index % (concurrency / repeatRatio), 0 , 0)
results[packageVersion] = try await manager.lookup(package: package, version: packageVersion, observabilityScope: observability.topScope, delegateQueue: .sharedConcurrent, callbackQueue: .sharedConcurrent)
}
}
try await group.waitForAll()
}
try delegate.wait(timeout: .now() + 2)
XCTAssertEqual(delegate.willFetch.count, concurrency / repeatRatio)
XCTAssertEqual(delegate.didFetch.count, concurrency / repeatRatio)
XCTAssertEqual(results.count, concurrency / repeatRatio)
for packageVersion in packageVersions {
let expectedPath = try downloadsPath.appending(package.downloadPath(version: packageVersion))
XCTAssertEqual(results[packageVersion], expectedPath)
}
}
}
}
private class MockRegistryDownloadsManagerDelegate: RegistryDownloadsManagerDelegate {
private var _willFetch = [(packageVersion: PackageVersion, fetchDetails: RegistryDownloadsManager.FetchDetails)]()
private var _didFetch = [(packageVersion: PackageVersion, result: Result<RegistryDownloadsManager.FetchDetails, Error>)]()
private let lock = NSLock()
private var group = DispatchGroup()
public func prepare(fetchExpected: Bool) {
if fetchExpected {
group.enter() // will fetch
group.enter() // did fetch
}
}
public func reset() {
self.group = DispatchGroup()
self._willFetch = []
self._didFetch = []
}
public func wait(timeout: DispatchTime) throws {
switch group.wait(timeout: timeout) {
case .success:
return
case .timedOut:
throw StringError("timeout")
}
}
var willFetch: [(packageVersion: PackageVersion, fetchDetails: RegistryDownloadsManager.FetchDetails)] {
return self.lock.withLock { _willFetch }
}
var didFetch: [(packageVersion: PackageVersion, result: Result<RegistryDownloadsManager.FetchDetails, Error>)] {
return self.lock.withLock { _didFetch }
}
func willFetch(package: PackageIdentity, version: Version, fetchDetails: RegistryDownloadsManager.FetchDetails) {
self.lock.withLock {
_willFetch += [(PackageVersion(package: package, version: version), fetchDetails: fetchDetails)]
}
self.group.leave()
}
func didFetch(package: PackageIdentity, version: Version, result: Result<RegistryDownloadsManager.FetchDetails, Error>, duration: DispatchTimeInterval) {
self.lock.withLock {
_didFetch += [(PackageVersion(package: package, version: version), result: result)]
}
self.group.leave()
}
func fetching(package: PackageIdentity, version: Version, bytesDownloaded downloaded: Int64, totalBytesToDownload total: Int64?) {
}
}
extension RegistryDownloadsManager {
fileprivate func lookup(package: PackageIdentity, version: Version, observabilityScope: ObservabilityScope) async throws -> AbsolutePath {
try await self.lookup(
package: package,
version: version,
observabilityScope: observabilityScope,
delegateQueue: .sharedConcurrent,
callbackQueue: .sharedConcurrent
)
}
}
fileprivate struct PackageVersion: Hashable, Equatable {
let package: PackageIdentity
let version: Version
}
|
