Remove histogram::Histogram from public API
#935
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
Public MetricsError enum contains a reference to `Histogram`. In fact, the `MetricsError::Poison` is never really constructed since we always unwrap the PoisonError when trying to acquire the mutex. This is why we get rid of the `MetricsError::Poison` enum value and convert the `MetricsError` enum to struct holding an error cause.
piodul
approved these changes
Feb 16, 2024
|
Curious, this was quite an obvious breaking change (removal of an enum variant in a public struct) but the semver checks job didn't report anything. |
|
Something went wrong when running the check:
Not sure what went wrong, but the CI job with the semver check should fail and not pass. I'll create an issue about that. In any case, this is not a blocker for merge. |
Merged
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.
Ref: #771
Motivation
histogramis an unstable crate and the types introduced by this crate need to be removed from our public API. The only type being used ishistogram::Histogram.It's exposed publicly via
MetricsError::Poison. However, theMetricsError::Poisonvalue is never constructed since we always unwrap thePoisonErrorwhen trying to acquire the lock.Changes
Removed
MetricsError::Poisonand refactoredMetricsErrorto be a struct holding an error cause (&'static strreturned from thehistogram::HistogramAPI).Pre-review checklist
./docs/source/.Fixes:annotations to PR description.