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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift 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 http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import SourceControl
import class Basics.ObservabilityScope
import class PackageGraph.ResolvedPackagesStore
import struct PackageModel.PackageReference
import struct PackageModel.ToolsVersion
import struct TSCUtility.Version
extension Workspace {
/// Saves all of the current managed dependencies at their checkout state in `Package.resolved` file.
func saveResolvedFile(
resolvedPackagesStore: ResolvedPackagesStore,
dependencyManifests: DependencyManifests,
originHash: String,
rootManifestsMinimumToolsVersion: ToolsVersion,
observabilityScope: ObservabilityScope
) async throws {
var dependenciesToSaveAsResolved = [ManagedDependency]()
let requiredDependencies = try dependencyManifests.requiredPackages.filter(\.kind.isResolvable)
for dependency in requiredDependencies {
if let managedDependency = await self.state.dependencies[comparingLocation: dependency] {
dependenciesToSaveAsResolved.append(managedDependency)
} else if let managedDependency = await self.state.dependencies[dependency.identity] {
observabilityScope
.emit(
info: "required dependency '\(dependency.identity)' from '\(dependency.locationString)' was not found in managed dependencies, using alternative location '\(managedDependency.packageRef.locationString)' instead"
)
dependenciesToSaveAsResolved.append(ManagedDependency(packageRef: dependency, state: managedDependency.state, subpath: managedDependency.subpath))
} else {
observabilityScope
.emit(
warning: "required dependency '\(dependency.identity)' from '\(dependency.locationString)' was not found in managed dependencies and will not be recorded in resolved file"
)
}
}
// try to load the `Package.resolved` store from disk so we can compare for any changes
// this is needed as we want to avoid re-writing the resolved files unless absolutely necessary
var needsUpdate = false
if let persistedResolvedPackagesStore = try? self.resolvedPackagesStore.load() {
// compare for any differences between the existing state and the stored one
// subtle changes between versions of SwiftPM could treat URLs differently
// in which case we don't want to cause unnecessary churn
if dependenciesToSaveAsResolved.count != persistedResolvedPackagesStore.resolvedPackages.count {
needsUpdate = true
} else {
for dependency in dependenciesToSaveAsResolved {
if let resolvedPackage = persistedResolvedPackagesStore.resolvedPackages[comparingLocation: dependency.packageRef] {
if resolvedPackage.state != ResolvedPackagesStore.ResolvedPackage(dependency)?.state {
needsUpdate = true
break
}
} else {
needsUpdate = true
break
}
}
}
} else {
needsUpdate = true
}
// exist early is there is nothing to do
if !needsUpdate {
return
}
// reset the `Package.resolved` store and start saving the required dependencies.
resolvedPackagesStore.reset()
for dependency in dependenciesToSaveAsResolved {
resolvedPackagesStore.add(dependency)
}
observabilityScope.trap {
try resolvedPackagesStore.saveState(
toolsVersion: rootManifestsMinimumToolsVersion,
originHash: originHash
)
}
// Ask resolved file watcher to update its value so we don't fire
// an extra event if the file was modified by us.
self.resolvedFileWatcher?.updateValue()
}
/// Watch the Package.resolved for changes.
///
/// This is useful if clients want to be notified when the Package.resolved
/// file is changed *outside* of libSwiftPM operations. For example, as part
/// of a git operation.
public func watchResolvedFile() throws {
// Return if we're already watching it.
guard self.resolvedFileWatcher == nil else { return }
self.resolvedFileWatcher = try ResolvedFileWatcher(
resolvedFile: self.location.resolvedVersionsFile
) { [weak self] in
self?.delegate?.resolvedFileChanged()
}
}
}
extension ResolvedPackagesStore {
/// Add a managed dependency at its checkout state as resolved.
///
/// This method does nothing if the dependency is in edited state.
func add(_ dependency: Workspace.ManagedDependency) {
if let resolvedPackage = ResolvedPackagesStore.ResolvedPackage(dependency) {
self.add(resolvedPackage)
}
}
}
extension ResolvedPackagesStore.ResolvedPackage {
fileprivate init?(_ dependency: Workspace.ManagedDependency) {
switch dependency.state {
case .sourceControlCheckout(.version(let version, let revision)):
self.init(
packageRef: dependency.packageRef,
state: .version(version, revision: revision.identifier)
)
case .sourceControlCheckout(.branch(let branch, let revision)):
self.init(
packageRef: dependency.packageRef,
state: .branch(name: branch, revision: revision.identifier)
)
case .sourceControlCheckout(.revision(let revision)):
self.init(
packageRef: dependency.packageRef,
state: .revision(revision.identifier)
)
case .registryDownload(let version):
self.init(
packageRef: dependency.packageRef,
state: .version(version, revision: .none)
)
case .edited, .fileSystem, .custom:
// NOOP
return nil
}
}
}
extension PackageReference.Kind {
var isResolvable: Bool {
switch self {
case .remoteSourceControl, .localSourceControl, .registry:
return true
default:
return false
}
}
}
extension ResolvedPackagesStore.ResolutionState {
func equals(_ checkoutState: CheckoutState) -> Bool {
switch (self, checkoutState) {
case (.version(let lversion, let lrevision), .version(let rversion, let rrevision)):
return lversion == rversion && lrevision == rrevision.identifier
case (.branch(let lbranch, let lrevision), .branch(let rbranch, let rrevision)):
return lbranch == rbranch && lrevision == rrevision.identifier
case (.revision(let lrevision), .revision(let rrevision)):
return lrevision == rrevision.identifier
default:
return false
}
}
func equals(_: Version) -> Bool {
switch self {
case .version(let version, _):
return version == version
default:
return false
}
}
}
extension ResolvedPackagesStore.ResolvedPackages {
subscript(comparingLocation package: PackageReference) -> ResolvedPackagesStore.ResolvedPackage? {
if let resolvedPackage = self[package.identity], resolvedPackage.packageRef.equalsIncludingLocation(package) {
return resolvedPackage
}
return .none
}
}
|
