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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2022 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 CoreCommands
import Dispatch
import class Foundation.NSLock
import struct Foundation.URL
import OrderedCollections
import PackageGraph
import PackageModel
import SPMBuildCore
import Workspace
import protocol TSCBasic.OutputByteStream
import struct TSCUtility.Version
final class CommandWorkspaceDelegate: WorkspaceDelegate {
private struct DownloadProgress {
let bytesDownloaded: Int64
let totalBytesToDownload: Int64
}
private struct FetchProgress {
let progress: Int64
let total: Int64
}
/// The progress of binary downloads.
private var binaryDownloadProgress = OrderedCollections.OrderedDictionary<String, DownloadProgress>()
private let binaryDownloadProgressLock = NSLock()
/// The progress of package fetch operations.
private var fetchProgress = OrderedCollections.OrderedDictionary<PackageIdentity, FetchProgress>()
private let fetchProgressLock = NSLock()
private let observabilityScope: ObservabilityScope
private let outputHandler: (String, Bool) -> Void
private let progressHandler: (Int64, Int64, String?) -> Void
private let inputHandler: (String, (String?) -> Void) -> Void
init(
observabilityScope: ObservabilityScope,
outputHandler: @escaping (String, Bool) -> Void,
progressHandler: @escaping (Int64, Int64, String?) -> Void,
inputHandler: @escaping (String, (String?) -> Void) -> Void
) {
self.observabilityScope = observabilityScope
self.outputHandler = outputHandler
self.progressHandler = progressHandler
self.inputHandler = inputHandler
}
func willFetchPackage(package: PackageIdentity, packageLocation: String?, fetchDetails: PackageFetchDetails) {
self.outputHandler("Fetching \(packageLocation ?? package.description)\(fetchDetails.fromCache ? " from cache" : "")", false)
}
func didFetchPackage(package: PackageIdentity, packageLocation: String?, result: Result<PackageFetchDetails, Error>, duration: DispatchTimeInterval) {
guard case .success = result, !self.observabilityScope.errorsReported else {
return
}
self.fetchProgressLock.withLock {
let progress = self.fetchProgress.values.reduce(0) { $0 + $1.progress }
let total = self.fetchProgress.values.reduce(0) { $0 + $1.total }
if progress == total && !self.fetchProgress.isEmpty {
self.fetchProgress.removeAll()
} else {
self.fetchProgress[package] = nil
}
}
self.outputHandler("Fetched \(packageLocation ?? package.description) from cache (\(duration.descriptionInSeconds))", false)
}
func fetchingPackage(package: PackageIdentity, packageLocation: String?, progress: Int64, total: Int64?) {
let (step, total, packages) = self.fetchProgressLock.withLock { () -> (Int64, Int64, String) in
self.fetchProgress[package] = FetchProgress(
progress: progress,
total: total ?? progress
)
let progress = self.fetchProgress.values.reduce(0) { $0 + $1.progress }
let total = self.fetchProgress.values.reduce(0) { $0 + $1.total }
let packages = self.fetchProgress.keys.map { $0.description }.joined(separator: ", ")
return (progress, total, packages)
}
self.progressHandler(step, total, "Fetching \(packages)")
}
func willUpdateRepository(package: PackageIdentity, repository url: String) {
self.outputHandler("Updating \(url)", false)
}
func didUpdateRepository(package: PackageIdentity, repository url: String, duration: DispatchTimeInterval) {
self.outputHandler("Updated \(url) (\(duration.descriptionInSeconds))", false)
}
func dependenciesUpToDate() {
self.outputHandler("Everything is already up-to-date", false)
}
func willCreateWorkingCopy(package: PackageIdentity, repository url: String, at path: AbsolutePath) {
self.outputHandler("Creating working copy for \(url)", false)
}
func didCheckOut(package: PackageIdentity, repository url: String, revision: String, at path: AbsolutePath, duration: DispatchTimeInterval) {
self.outputHandler("Working copy of \(url) resolved at \(revision)", false)
}
func removing(package: PackageIdentity, packageLocation: String?) {
self.outputHandler("Removing \(packageLocation ?? package.description)", false)
}
func willResolveDependencies(reason: WorkspaceResolveReason) {
self.outputHandler(Workspace.format(workspaceResolveReason: reason), true)
}
func willComputeVersion(package: PackageIdentity, location: String) {
self.outputHandler("Computing version for \(location)", false)
}
func didComputeVersion(package: PackageIdentity, location: String, version: String, duration: DispatchTimeInterval) {
self.outputHandler("Computed \(location) at \(version) (\(duration.descriptionInSeconds))", false)
}
func willDownloadBinaryArtifact(from url: String, fromCache: Bool) {
if fromCache {
self.outputHandler("Fetching binary artifact \(url) from cache", false)
} else {
self.outputHandler("Downloading binary artifact \(url)", false)
}
}
func didDownloadBinaryArtifact(from url: String, result: Result<(path: AbsolutePath, fromCache: Bool), Error>, duration: DispatchTimeInterval) {
guard case .success(let fetchDetails) = result, !self.observabilityScope.errorsReported else {
return
}
self.binaryDownloadProgressLock.withLock {
let progress = self.binaryDownloadProgress.values.reduce(0) { $0 + $1.bytesDownloaded }
let total = self.binaryDownloadProgress.values.reduce(0) { $0 + $1.totalBytesToDownload }
if progress == total && !self.binaryDownloadProgress.isEmpty {
self.binaryDownloadProgress.removeAll()
} else {
self.binaryDownloadProgress[url] = nil
}
}
if fetchDetails.fromCache {
self.outputHandler("Fetched \(url) from cache (\(duration.descriptionInSeconds))", false)
} else {
self.outputHandler("Downloaded \(url) (\(duration.descriptionInSeconds))", false)
}
}
func downloadingBinaryArtifact(from url: String, bytesDownloaded: Int64, totalBytesToDownload: Int64?) {
let (step, total, artifacts) = self.binaryDownloadProgressLock.withLock { () -> (Int64, Int64, String) in
self.binaryDownloadProgress[url] = DownloadProgress(
bytesDownloaded: bytesDownloaded,
totalBytesToDownload: totalBytesToDownload ?? bytesDownloaded
)
let step = self.binaryDownloadProgress.values.reduce(0, { $0 + $1.bytesDownloaded })
let total = self.binaryDownloadProgress.values.reduce(0, { $0 + $1.totalBytesToDownload })
let artifacts = self.binaryDownloadProgress.keys.joined(separator: ", ")
return (step, total, artifacts)
}
self.progressHandler(step, total, "Downloading \(artifacts)")
}
// registry signature handlers
func onUnsignedRegistryPackage(registryURL: URL, package: PackageModel.PackageIdentity, version: TSCUtility.Version, completion: (Bool) -> Void) {
self.inputHandler("\(package) \(version) from \(registryURL) is unsigned. okay to proceed? (yes/no) ") { response in
switch response?.lowercased() {
case "yes":
completion(true) // continue
case "no":
completion(false) // stop resolution
default:
self.outputHandler("invalid response: '\(response ?? "")'", false)
completion(false)
}
}
}
func onUntrustedRegistryPackage(registryURL: URL, package: PackageModel.PackageIdentity, version: TSCUtility.Version, completion: (Bool) -> Void) {
self.inputHandler("\(package) \(version) from \(registryURL) is signed with an untrusted certificate. okay to proceed? (yes/no) ") { response in
switch response?.lowercased() {
case "yes":
completion(true) // continue
case "no":
completion(false) // stop resolution
default:
self.outputHandler("invalid response: '\(response ?? "")'", false)
completion(false)
}
}
}
public func willUpdateDependencies() {
self.observabilityScope.emit(debug: "Updating dependencies")
os_signpost(.begin, name: SignpostName.updatingDependencies)
}
public func didUpdateDependencies(duration: DispatchTimeInterval) {
self.observabilityScope.emit(debug: "Dependencies updated in (\(duration.descriptionInSeconds))")
os_signpost(.end, name: SignpostName.updatingDependencies)
}
public func willResolveDependencies() {
self.observabilityScope.emit(debug: "Resolving dependencies")
os_signpost(.begin, name: SignpostName.resolvingDependencies)
}
public func didResolveDependencies(duration: DispatchTimeInterval) {
self.observabilityScope.emit(debug: "Dependencies resolved in (\(duration.descriptionInSeconds))")
os_signpost(.end, name: SignpostName.resolvingDependencies)
}
func willLoadGraph() {
self.observabilityScope.emit(debug: "Loading and validating graph")
os_signpost(.begin, name: SignpostName.loadingGraph)
}
func didLoadGraph(duration: DispatchTimeInterval) {
self.observabilityScope.emit(debug: "Graph loaded in (\(duration.descriptionInSeconds))")
os_signpost(.end, name: SignpostName.loadingGraph)
}
func didCompileManifest(packageIdentity: PackageIdentity, packageLocation: String, duration: DispatchTimeInterval) {
self.observabilityScope.emit(debug: "Compiled manifest for '\(packageIdentity)' (from '\(packageLocation)') in \(duration.descriptionInSeconds)")
}
func didEvaluateManifest(packageIdentity: PackageIdentity, packageLocation: String, duration: DispatchTimeInterval) {
self.observabilityScope.emit(debug: "Evaluated manifest for '\(packageIdentity)' (from '\(packageLocation)') in \(duration.descriptionInSeconds)")
}
func didLoadManifest(packageIdentity: PackageIdentity, packagePath: AbsolutePath, url: String, version: Version?, packageKind: PackageReference.Kind, manifest: Manifest?, diagnostics: [Basics.Diagnostic], duration: DispatchTimeInterval) {
self.observabilityScope.emit(debug: "Loaded manifest for '\(packageIdentity)' (from '\(url)') in \(duration.descriptionInSeconds)")
}
// noop
func willCheckOut(package: PackageIdentity, repository url: String, revision: String, at path: AbsolutePath) {}
func didCreateWorkingCopy(package: PackageIdentity, repository url: String, at path: AbsolutePath, duration: DispatchTimeInterval) {}
func resolvedFileChanged() {}
func didDownloadAllBinaryArtifacts() {}
func willCompileManifest(packageIdentity: PackageIdentity, packageLocation: String) {}
func willEvaluateManifest(packageIdentity: PackageIdentity, packageLocation: String) {}
func willLoadManifest(packageIdentity: PackageIdentity, packagePath: AbsolutePath, url: String, version: Version?, packageKind: PackageReference.Kind) {}
}
public extension _SwiftCommand {
var workspaceDelegateProvider: WorkspaceDelegateProvider {
return {
CommandWorkspaceDelegate(
observabilityScope: $0,
outputHandler: $1,
progressHandler: $2,
inputHandler: $3
)
}
}
var workspaceLoaderProvider: WorkspaceLoaderProvider {
return {
XcodeWorkspaceLoader(fileSystem: $0, observabilityScope: $1)
}
}
}
|
