Introduce LibraryInstallationGoalState #743
Merged
Conversation
This file contains 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
jimmylewis
force-pushed
the
goalstate
branch
2 times, most recently
from
64210f6 to
3771b60
Compare
jimmylewis
force-pushed
the
goalstate
branch
2 times, most recently
from
f848dc8 to
a30dc6b
Compare
The existing LibraryInstallationState abstraction is not flexible about mapping files to their source on an individual basis. It presumes that all files installed by a library retain the same folder hierarchy as the library they originate from. In order to allow more flexibility, this change adds a new abstraction to wrap all installed files to their individual source files. This eliminates the prior assumption, allowing for flexibility to install files to a different folder hierarchy than their originating library structure. This flexibility also allows an important new concept: each destination file must be unique (to avoid collisions), but the sources are not so constrained. A single source file may be installed to multiple destinations; by creating a mapping of destination-to-source, we can easily allow this. This change prepares for a new feature to allow more granular mappings of files within a library.
Also updated Manifest to use the goal state for the uninstall scenario.
Needed so that FileSystemProvider can override the default behavior, since it doesn't use the same cache logic as other providers.
phil-allen-msft
approved these changes
May 20, 2024
| /// <summary> | ||
| /// Returns whether the goal is in an achieved state - that is, all files are up to date. | ||
| /// </summary> | ||
| public bool IsAchieved() |
There was a problem hiding this comment.
I like the name "achieved" as a word to match "goal", but it seems like if http URLs can never be achieved, maybe the method name could be "IsLocallyAcheived" as opposed to an IsAchievedAsync(cancellationtoken) that would actually make network calls to try and verify. Thoughts?
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.
This change refactors how we track the state of which files get installed from each library. The LibraryInstallationGoalState is a mapping of destination files to their sources (where the source is from the local file cache if applicable).
In a manner of speaking, if LibraryInstallationState ("LIS") is the input ("I want these files from this library from that provider"), then LibraryInstallationGoalState ("LIGS") is a computed output of exactly what work needs to be performed ("These files are copied to those destinations").
This design offers some additional flexibility.