make package.resolved more deterministic in edge cases #3967
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
motivation: in some cases like two URLs with casing differences, package.resolved could be non-deterministic changes: * make the maanged dependencies location lookup case insensitive * refactor how package.resolved is saved to test for non material differences * adjust call sites that manipulate the pin store to be more efficient about when to save the resolved file * add warning when expected dependency that should be stored in the resolved file is not found * adjust call sites TODO: add tests
… it to compare locations where required * rename LegacyPackageIdentity as PackageIdentityParser and simplify how identity parsing is wired (removed unusued complexity)
tomerd
force-pushed
the
fix/manage-deps-comparison
branch
from
1b7138c to
e37c93b
Compare
|
@swift-ci smoke test |
|
@swift-ci please test package compatibility |
abertelrud
reviewed
Jan 4, 2022
Sources/Workspace/Workspace.swift
Outdated
| // load the pin 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 required | ||
| guard let storedPinStore = observabilityScope.trap({ try self.pinsStore.load() }) else { |
There was a problem hiding this comment.
So if this fails, such as because of an I/O error, would it be better to try to write the new file anyway? I guess I'm questioning whether returning here is the right thing.
There was a problem hiding this comment.
are you suggesting we try rewrite if we cant read? I can go with that too
There was a problem hiding this comment.
Yes, exactly (I should have been more clear). Since the only reason we're reading it is to avoid unnecessary changes, it seems reasonable to write it out if the read fails. Of course, if it's a permission issue, the write may still fail, but that's a separate issue.
tomerd
force-pushed
the
fix/manage-deps-comparison
branch
from
7488194 to
fbbda78
Compare
tomerd
changed the title
tomerd
added
ready
|
@swift-ci please smoke test |
tomerd
changed the title
|
@swift-ci please test package compatibility |
neonichu
approved these changes
Jan 5, 2022
abertelrud
approved these changes
Jan 5, 2022
abertelrud
reviewed
Jan 5, 2022
| } | ||
|
|
||
| observabilityScope.trap{ | ||
| // exist early is there is nothing to do |
There was a problem hiding this comment.
Suggested change
| // exist early is there is nothing to do | |
| // exit early if there is nothing to do |
tomerd
added a commit
to tomerd/swift-package-manager
that referenced
this pull request
Jan 6, 2022
motivation: in some cases like two URLs with casing differences, package.resolved could be non-deterministic changes: * base managed dependencies lookup on canonical location (case insensitive, ignore .git suffix) * refactor how package.resolved is saved to test for non material differences * adjust call sites that manipulate the pin store to be more efficient about when to save the resolved file * add warning when expected dependency that should be stored in the resolved file is not found * rename CanonicalPackageIdentity as CanonicalPackageLocation and use it to compare locations where required * rename LegacyPackageIdentity as PackageIdentityParser and simplify how identity parsing is wired (removed unusued complexity) * adjust call sites * add and adjust test
tomerd
added a commit
that referenced
this pull request
Jan 6, 2022
motivation: in some cases like two URLs with casing differences, package.resolved could be non-deterministic changes: * base managed dependencies lookup on canonical location (case insensitive, ignore .git suffix) * refactor how package.resolved is saved to test for non material differences * adjust call sites that manipulate the pin store to be more efficient about when to save the resolved file * add warning when expected dependency that should be stored in the resolved file is not found * rename CanonicalPackageIdentity as CanonicalPackageLocation and use it to compare locations where required * rename LegacyPackageIdentity as PackageIdentityParser and simplify how identity parsing is wired (removed unusued complexity) * adjust call sites * add and adjust test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
motivation: in some cases like two URLs with casing differences, package.resolved could be non-deterministic
changes: