fix: classify WAL restore errors with precise gRPC statuses#927
Open
leonardoce wants to merge 4 commits into
Open
fix: classify WAL restore errors with precise gRPC statuses#927leonardoce wants to merge 4 commits into
leonardoce wants to merge 4 commits into
Conversation
dosubot
Bot
added
size:XS
leonardoce
force-pushed
the
transient-status
branch
from
163c47f to
40f7ce2
Compare
dosubot
Bot
added
size:M
Contributor
Author
|
This PR needs cloudnative-pg/barman-cloud#253 |
Map each restorer sentinel to the gRPC status that best reflects whether the operator should retry: - ErrWALNotFound -> NotFound (terminal) - ErrInvalidWalName -> InvalidArgument (terminal) - ErrConnectivity -> Unavailable (retry) - ErrGeneric -> Unavailable (retry) - anything else -> Internal (terminal) Previously every non-NotFound failure was returned verbatim, leaving the operator unable to tell transient blips apart from terminal conditions like a malformed WAL name. Signed-off-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
The per-case and helper comments asserted what the operator will do
with each gRPC code ("the operator stops retrying", "the operator
will retry the request", etc.). On the current cloudnative-pg main,
the operator only differentiates ErrWALNotFound; the precise-code
distinctions become meaningful only after the operator-side retry
work lands.
Rewrite the comments to describe what the code emits and why (per
gRPC convention), so they stay accurate regardless of the operator
version on the other end. Also note that barman returns ErrGeneric
(exit 4) for some retryable conditions too — not only ErrConnectivity
(exit 2) — which justifies why both map to codes.Unavailable.
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
Extract the barman-restorer error -> gRPC code switch from
restoreFromBarmanObjectStore into a pure helper,
classifyWALRestoreError, so it can be exercised in isolation
without the surrounding k8s client / configuration scaffolding.
Add ginkgo specs that check:
- each barman sentinel maps to the expected gRPC status code
(ErrConnectivity and ErrGeneric both -> Unavailable, since
barman uses exit 4 for some retryable conditions too),
- an unclassified error falls through to codes.Internal,
- classification still works through multiple fmt.Errorf wraps,
- the switch matches by errors.Is identity rather than message
substring (so a NotFound whose message happens to mention
"connectivity" still maps to NotFound).
internal/cnpgi/common had no tests before; this introduces the
suite scaffolding alongside the new specs.
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
armru
approved these changes
May 28, 2026
…s addition The replace directive in go.mod pulls in a barman-cloud version that exposes the new restoreAdditionalCommandArgs field on BarmanObjectStoreConfiguration. The plugin's CRD embeds that struct, so controller-gen + kustomize must be rerun to surface the field in the published CRD and bundled manifest. CI's uncommitted-changes guard caught the gap. Regenerated with controller-gen v0.21.0 (matching the daggerverse module version) and kustomize v5.5.0; only the new field is added, no annotation drift. Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
Contributor
|
I have created this ticket in Barman Cloud: EnterpriseDB/barman#1193 |
Contributor
I have proposed this PR. |
Contributor
Merged! |
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
3 participants
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.
Map each restorer sentinel to the gRPC status that best reflects whether the operator should retry:
Previously every non-NotFound failure was returned verbatim, leaving the operator unable to tell transient blips apart from terminal conditions like a malformed WAL name.