fix: update the simple profile to avoid Container.can_connect #1927
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
lengau
approved these changes
Oct 8, 2024
tigarmo
approved these changes
Oct 9, 2024
lengau
pushed a commit
that referenced
this pull request
Oct 11, 2024
Using `Container.can_connect` as a guard for Pebble is a poor pattern,
because it introduces a race condition. We recommend that charms use the
"easier to ask forgiveness than permission" pattern by executing the
container calls and catching any errors that occur. This PR updates the
`simple` profile to use that pattern.
There are two other small changes:
* The message in the blocked status was intending to use an f-string,
but was just a regular string, so would have always shown the literal
text "{log_level}" rather than the value of that variable.
* `WaitingStatus` should be used when waiting on an integrated charm,
not the local charm. `MaintenanceStatus` is the correct class to use
when waiting on the local charm.
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.
Using
Container.can_connectas a guard for Pebble is a poor pattern, because it introduces a race condition. We recommend that charms use the "easier to ask forgiveness than permission" pattern by executing the container calls and catching any errors that occur. This PR updates thesimpleprofile to use that pattern.There are two other small changes:
WaitingStatusshould be used when waiting on an integrated charm, not the local charm.MaintenanceStatusis the correct class to use when waiting on the local charm.