Make add-dependency idempotent #8534
Conversation
plemarquand
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
|
@swift-ci please test |
| /// If the exact same dependency already exists, `false` is returned to indicate | ||
| /// that no edits are needed. If a different dependency with the same id or url | ||
| /// with different arguments exists, an error is thrown. | ||
| private static func checkExistingDependency( |
There was a problem hiding this comment.
question: I know this is marked as a private function, but is there value is validate this function in isolation to ensure we can test all code paths to ensure the behaviour is as expected, as opposed to testing the implementation?
| try await executeAddURLDependencyAndAssert( | ||
| packagePath: path, | ||
| initialManifest: manifest, | ||
| url: "https://github.com/swiftlang/swift-syntax.git", |
There was a problem hiding this comment.
question: Does SwiftPM treat a package dependency of "https://github.com/swiftlang/swift-syntax.git" the same as "https://github.com/swiftlang/swift-syntax"? Is there value if documenting this specific case?
what about repositories that has the same name, but belong to different organizations/users?
|
@swift-ci test windows platform |
|
@swift-ci test |
If a manifest already contains the exact dependency is being added via a `add-dependency` call, don't add it twice. Instead, do nothing. This ensures we don't end up with an invalid manifest with two of the same dependencies in it. If a manifest contains a dependency with the supplied URL but a different version qualifier then throw an error explaining that the supplied dependency has already been added. Issue: swiftlang#8519
plemarquand
force-pushed
the
idempotent-add-dependency
branch
from
571350e to
518c227
Compare
|
@swift-ci test |
|
@swift-ci please test windows |
|
@swift-ci test windows |
1 similar comment
|
@swift-ci test windows |
Motivation:
If the same dependency is added twice with different version specifiers the manifest is no longer valid. If the same dependency is added twice with the same version specifier it remains valid, but less maintainable.
Modifications:
If a manifest already contains the exact dependency and version that is being added via a
add-dependencycall, don't add it twice. Instead, do nothing.If a manifest contains a dependency with the supplied URL but a different version qualifier then throw an error explaining that the supplied dependency has already been added.
Result:
A manifest that continues to parse correctly.
Issue: #8519