feat!: Remove interior mutability of HealthCheckRegistry - #258
Merged
Conversation
Switch to using `OnceLock` to allow setting the health checks on the `AppContext` after it is created. The method to set the health checks is private to the crate, so we have control over when the checks are set on the context. This has some impacts on public-facing APIs: - `App::health_checks` takes a `&mut HealthCheckRegistry` instead of a non-mutable ref - `AppContext::health_checks` returns the list of health checks. (Alternatively, we could have returned an Option) - We also made the `HealthCheckRegistry::new` method non-public. This aligns with the `ServiceRegistry::new` visibility.
Codecov ReportAttention: Patch coverage is
... and 3 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
Merged
spencewenski
pushed a commit
that referenced
this pull request
Jul 1, 2024
## 🤖 New release * `roadster`: 0.4.0 -> 0.5.0 <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.5.0](roadster-v0.4.0...roadster-v0.5.0) - 2024-07-01 ### Added - [**breaking**] Remove interior mutability of `HealthCheckRegistry` ([#258](#258)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Switch to using
OnceLockto allow setting the health checks on theAppContextafter it is created. The method to set the health checks is private to the crate, so we have control over when the checks are set on the context.This has some impacts on public-facing APIs:
App::health_checkstakes a&mut HealthCheckRegistryinstead of a non-mutable refAppContext::health_checksreturns the list of health checks. (Alternatively, we could have returned an Option)HealthCheckRegistry::newmethod non-public. This aligns with theServiceRegistry::newvisibility.Closes #257