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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift 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 http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import Dispatch
import PackageGraph
import PackageLoading
import PackageModel
import struct TSCUtility.Version
/// Local file system package container.
///
/// This class represent packages that are referenced locally in the file system.
/// There is no need to perform any git operations on such packages and they
/// should be used as-is. In fact, they might not even have a git repository.
/// Examples: Root packages, local dependencies, edited packages.
public struct FileSystemPackageContainer: PackageContainer {
public let package: PackageReference
private let identityResolver: IdentityResolver
private let dependencyMapper: DependencyMapper
private let manifestLoader: ManifestLoaderProtocol
private let currentToolsVersion: ToolsVersion
/// File system that should be used to load this package.
private let fileSystem: FileSystem
/// Observability scope to emit diagnostics
private let observabilityScope: ObservabilityScope
/// cached version of the manifest
private let manifest = ThreadSafeBox<Manifest>()
public init(
package: PackageReference,
identityResolver: IdentityResolver,
dependencyMapper: DependencyMapper,
manifestLoader: ManifestLoaderProtocol,
currentToolsVersion: ToolsVersion,
fileSystem: FileSystem,
observabilityScope: ObservabilityScope
) throws {
switch package.kind {
case .root, .fileSystem:
break
default:
throw InternalError("invalid package type \(package.kind)")
}
self.package = package
self.identityResolver = identityResolver
self.dependencyMapper = dependencyMapper
self.manifestLoader = manifestLoader
self.currentToolsVersion = currentToolsVersion
self.fileSystem = fileSystem
self.observabilityScope = observabilityScope.makeChildScope(
description: "FileSystemPackageContainer",
metadata: package.diagnosticsMetadata)
}
private func loadManifest() throws -> Manifest {
try manifest.memoize() {
let packagePath: AbsolutePath
switch self.package.kind {
case .root(let path), .fileSystem(let path):
packagePath = path
default:
throw InternalError("invalid package type \(package.kind)")
}
// Load the manifest.
// FIXME: this should not block
return try temp_await {
manifestLoader.load(
packagePath: packagePath,
packageIdentity: self.package.identity,
packageKind: self.package.kind,
packageLocation: self.package.locationString,
packageVersion: nil,
currentToolsVersion: self.currentToolsVersion,
identityResolver: self.identityResolver,
dependencyMapper: self.dependencyMapper,
fileSystem: self.fileSystem,
observabilityScope: self.observabilityScope,
delegateQueue: .sharedConcurrent,
callbackQueue: .sharedConcurrent,
completion: $0
)
}
}
}
public func getUnversionedDependencies(productFilter: ProductFilter) throws -> [PackageContainerConstraint] {
let manifest = try self.loadManifest()
return try manifest.dependencyConstraints(productFilter: productFilter)
}
public func loadPackageReference(at boundVersion: BoundVersion) throws -> PackageReference {
assert(boundVersion == .unversioned, "Unexpected bound version \(boundVersion)")
let manifest = try loadManifest()
return package.withName(manifest.displayName)
}
public func isToolsVersionCompatible(at version: Version) -> Bool {
fatalError("This should never be called")
}
public func toolsVersion(for version: Version) throws -> ToolsVersion {
fatalError("This should never be called")
}
public func toolsVersionsAppropriateVersionsDescending() throws -> [Version] {
fatalError("This should never be called")
}
public func versionsAscending() throws -> [Version] {
fatalError("This should never be called")
}
public func getDependencies(at version: Version, productFilter: ProductFilter) throws -> [PackageContainerConstraint] {
fatalError("This should never be called")
}
public func getDependencies(at revision: String, productFilter: ProductFilter) throws -> [PackageContainerConstraint] {
fatalError("This should never be called")
}
}
extension FileSystemPackageContainer: CustomStringConvertible {
public var description: String {
return "FileSystemPackageContainer(\(self.package.identity))"
}
}
|
