Use cargo-check-external-types to control type leakage in public API #202
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 commit replaces the `From<untrusted::EndOfInput>` impl on the exported `Error` type with a crate-private `der::end_of_input_err` helper. This prevents `untrusted` from leaking into the webpki API surface.
This commit adds a CI task to run cargo-check-external-types[0] with the goal of ensuring we don't unintentionally leak types from deps (e.g. `untrusted`) in our public API. [0]: https://github.com/awslabs/cargo-check-external-types
Codecov Report
@@ Coverage Diff @@
## main #202 +/- ##
=======================================
Coverage 96.73% 96.73%
=======================================
Files 20 20
Lines 4749 4749
=======================================
Hits 4594 4594
Misses 155 155
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ctz
approved these changes
Oct 18, 2023
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.
Like rustls/rustls#1535, this branch brings the cargo-check-external-types tool to the webpki repo. This will help us catch unintended leaking of types from dependencies into the public API. One such occurrence is caught by the tool and fixed alongside adding it to CI.