Skip to content

use resolved location when managed dependencies and resolved graph do not agree #7034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

use resolved location when managed dependencies and resolved graph do not agree #7034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Sources/Workspace/Workspace+Pinning.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,16 @@ extension Workspace {
for dependency in requiredDependencies {
if let managedDependency = self.state.dependencies[comparingLocation: dependency] {
dependenciesToPin.append(managedDependency)
} else if let managedDependency = 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"
)
dependenciesToPin.append(ManagedDependency(packageRef: dependency, state: managedDependency.state, subpath: managedDependency.subpath))
} else {
observabilityScope
.emit(
warning: "required dependency \(dependency.identity) (\(dependency.locationString)) was not found in managed dependencies and will not be recorded in resolved file"
warning: "required dependency '\(dependency.identity)' from '\(dependency.locationString)' was not found in managed dependencies and will not be recorded in resolved file"
)
}
}
Expand Down
156 changes: 156 additions & 0 deletions Tests/WorkspaceTests/WorkspaceTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11319,6 +11319,162 @@ final class WorkspaceTests: XCTestCase {
}
}

func testCanonicalURLWithPreviousManagedState() throws {
let sandbox = AbsolutePath("/tmp/ws/")
let fs = InMemoryFileSystem()

let workspace = try MockWorkspace(
sandbox: sandbox,
fileSystem: fs,
roots: [
MockPackage(
name: "Root",
targets: [
MockTarget(name: "RootTarget", dependencies: [
.product(name: "BarProduct", package: "bar"),
]),
],
dependencies: [
.sourceControl(
url: "https://github.com/org/bar.git",
requirement: .upToNextMajor(from: "1.0.0")
)
]
),
MockPackage(
name: "Root2",
targets: [
MockTarget(name: "RootTarget", dependencies: [
.product(name: "BarProduct", package: "bar"),
.product(name: "BazProduct", package: "baz"),
]),
],
dependencies: [
.sourceControl(
url: "https://github.com/org/bar.git",
requirement: .upToNextMajor(from: "1.0.0")
),
.sourceControl(
url: "https://github.com/org/baz.git",
requirement: .upToNextMajor(from: "1.0.0")
)
]
)
],
packages: [
MockPackage(
name: "FooPackage",
url: "https://github.com/org/foo.git",
targets: [
MockTarget(name: "FooTarget"),
],
products: [
MockProduct(name: "FooProduct", targets: ["FooTarget"]),
],
versions: ["1.0.0", "1.1.0"],
revisionProvider: { _ in "foo" } // we need this to be consistent for fingerprints check to work
),
MockPackage(
name: "FooPackage",
url: "[email protected]:org/foo.git",
targets: [
MockTarget(name: "FooTarget"),
],
products: [
MockProduct(name: "FooProduct", targets: ["FooTarget"]),
],
versions: ["1.0.0", "1.1.0"],
revisionProvider: { _ in "foo" } // we need this to be consistent for fingerprints check to work
),
MockPackage(
name: "BarPackage",
url: "https://github.com/org/bar.git",
targets: [
MockTarget(name: "BarTarget", dependencies: [
.product(name: "FooProduct", package: "foo"),
]),
],
products: [
MockProduct(name: "BarProduct", targets: ["BarTarget"]),
],
dependencies: [
.sourceControl(
url: "[email protected]:org/foo.git",
requirement: .upToNextMajor(from: "1.0.0")
),
],
versions: ["1.0.0", "1.1.0", "1.2.0"],
revisionProvider: { _ in "bar" } // we need this to be consistent for fingerprints check to work
),
MockPackage(
name: "BazPackage",
url: "https://github.com/org/baz.git",
targets: [
MockTarget(name: "BazTarget", dependencies: [
.product(name: "FooProduct", package: "foo"),
]),
],
products: [
MockProduct(name: "BazProduct", targets: ["BazTarget"]),
],
dependencies: [
.sourceControl(
url: "https://github.com/org/foo",
requirement: .upToNextMajor(from: "1.0.0")
),
],
versions: ["1.0.0", "1.1.0", "1.2.0"],
revisionProvider: { _ in "baz" } // we need this to be consistent for fingerprints check to work
)
]
)

// resolve to set previous state

try workspace.checkPackageGraph(roots: ["Root"]) { graph, diagnostics in
XCTAssertNoDiagnostics(diagnostics)
PackageGraphTester(graph) { result in
result.check(packages: "BarPackage", "FooPackage", "Root")
let package = result.find(package: "foo")
XCTAssertEqual(package?.manifest.packageLocation, "[email protected]:org/foo.git")
}
}

workspace.checkManagedDependencies { result in
XCTAssertEqual(result.managedDependencies["foo"]?.packageRef.locationString, "[email protected]:org/foo.git")
}

workspace.checkResolved { result in
XCTAssertEqual(result.store.pins["foo"]?.packageRef.locationString, "[email protected]:org/foo.git")
}

// update to a different url via transitive dependencies

try workspace.checkPackageGraph(roots: ["Root2"]) { graph, diagnostics in
XCTAssertNoDiagnostics(diagnostics)
PackageGraphTester(graph) { result in
result.check(packages: "BarPackage", "BazPackage", "FooPackage", "Root2")
let package = result.find(package: "foo")
XCTAssertEqual(package?.manifest.packageLocation, "[email protected]:org/foo.git")
}
testPartialDiagnostics(diagnostics, minSeverity: .debug) { result in
result.checkUnordered(
diagnostic: "required dependency 'foo' from 'https://github.com/org/foo' was not found in managed dependencies, using alternative location '[email protected]:org/foo.git' instead",
severity: .info
)
}
}

workspace.checkManagedDependencies { result in
// we expect the managed dependency to carry the old state
XCTAssertEqual(result.managedDependencies["foo"]?.packageRef.locationString, "[email protected]:org/foo.git")
}

workspace.checkResolved { result in
XCTAssertEqual(result.store.pins["foo"]?.packageRef.locationString, "https://github.com/org/foo")
}
}

func testCanonicalURLChanges() throws {
let sandbox = AbsolutePath("/tmp/ws/")
let fs = InMemoryFileSystem()
Expand Down