-
Notifications
You must be signed in to change notification settings - Fork 28
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.
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
twoliter: refactor lock & project interfaces #363
Merged
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
This funnels vendor lookups into receiving an enum, which forces callers handling an image's vendor to explicitly handle overrides.
The lock abstractions force the project interface to perform the appropriate validations when resolving and using dependencies. This change moves the `lock` module under `project` so that we can more-tightly control access to that functionality.
bcressey
approved these changes
Sep 9, 2024
jmt-lab
approved these changes
Sep 10, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
bcressey
approved these changes
Sep 11, 2024
twoliter/src/project/mod.rs
Outdated
Comment on lines
298
to
302
pub(crate) fn sdk_image(&self) -> ProjectImage { | ||
let Locked(lock) = &self.lock; | ||
self.as_project_image(&lock.sdk) | ||
.expect("Could not find kit vendor despite lock resolution succeeding?") | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the right error message?
Suggested change
pub(crate) fn sdk_image(&self) -> ProjectImage { | |
let Locked(lock) = &self.lock; | |
self.as_project_image(&lock.sdk) | |
.expect("Could not find kit vendor despite lock resolution succeeding?") | |
} | |
pub(crate) fn sdk_image(&self) -> ProjectImage { | |
let Locked(lock) = &self.lock; | |
self.as_project_image(&lock.sdk) | |
.expect("Could not find SDK vendor despite lock resolution succeeding?") | |
} |
^ force push for feedback from @bcressey |
Twoliter had a bug in which overridden SDK images were resolved, but then the wrong SDK was being passed into builds. This change: * Uses the the sealed trait/typestate pattern to modify the Project with interfaces to fetch images based on the lock level. * Provides clarified public interfaces for getting images from pre/post lock resolution. * Forces public and private callers to deal with possibly-overridden images.
bcressey
approved these changes
Sep 11, 2024
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.
Description of changes:
While working on #361 I started to consider how to better close-off some of these verification abstractions. Separately, I had an idea on how to make it so that
ImageResolver
could be less aware of how overrides are stored.This PR contains two minor refactors to existing APIs to try and more-tightly control usage of those APIs via privacy and type constraints.
Testing done:
bottlerocket-core-kit
bottlerocket
variantsTerms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.