Make the Buildpack API version check more robust #421
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
Previously, if a `buildpack.toml` either: 1. Didn't match the specific custom buildpack type (used when custom fields are specified under `[[metadata]]`) 2. Didn't match the CNB spec ...then a generic "failed to deserialise buildpack.toml" message was shown, rather than any error about the buildpack API version not matching. In cases where the chosen API version is actually the cause of the error (for example if a future API version makes breaking changes to the schema), then this means the underlying cause isn't mentioned. Now, the check uses a minimal `BuildpackDescriptorApiOnly` type when deserialising `buildpack.toml`, to ensure the API version can still be determined in those cases. The `BuildpackDescriptorApiOnly` type was used instead of a raw `toml::value::Table` since otherwise there are a myriad of `Option`s and related to handle, from both the potential lack of `api` field and it not having a value of type string etc.
edmorley
force-pushed
the
edmorley/improve-api-version-mismatch-check
branch
from
790e5f3 to
6d5d9aa
Compare
Malax
approved these changes
Jun 22, 2022
|
@Malax Yeah I wasn't sure if it should be or not. I can move it into |
|
@edmorley Yeah, that is what I had in mind. 👍🏻 |
edmorley
force-pushed
the
edmorley/improve-api-version-mismatch-check
branch
from
bb87511 to
85655e6
Compare
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.
Previously, if a
buildpack.tomleither:[[metadata]])...then a generic "failed to deserialise buildpack.toml" message was shown, rather than any error about the buildpack API version not matching.
In cases where the chosen API version is actually the cause of the error (for example if a future API version makes breaking changes to the schema), then this means the underlying cause isn't mentioned.
Now, the check uses a minimal
BuildpackDescriptorApiOnlytype when deserialisingbuildpack.toml, to ensure the API version can still be determined in those cases.The
BuildpackDescriptorApiOnlytype was used instead of a rawtoml::value::Table, since otherwise there are a myriad ofOptions and related to handle, from both the potential lack ofapifield and it not having a value of type string etc.GUS-W-11324328.