mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-07-07 02:02:21 +02:00
f9e3eaf49b
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>
83 lines
2.8 KiB
Go
83 lines
2.8 KiB
Go
/*
|
|
Copyright © contributors to CloudNativePG, established as
|
|
CloudNativePG a Series of LF Projects, LLC.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
package common
|
|
|
|
import (
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
)
|
|
|
|
// ErrEndOfWALStreamReached is returned when end of WAL is detected in the cloud archive.
|
|
var ErrEndOfWALStreamReached = status.Errorf(codes.OutOfRange, "end of WAL reached")
|
|
|
|
// ErrMissingPermissions is raised when the sidecar has no
|
|
// permission to download the credentials needed to reach
|
|
// the object storage.
|
|
// This will be fixed by the reconciliation loop in the
|
|
// operator plugin.
|
|
var ErrMissingPermissions = status.Errorf(codes.FailedPrecondition,
|
|
"no permission to download the backup credentials, retrying")
|
|
|
|
// newWALNotFoundError reports that the requested WAL file is not
|
|
// present in the object store. Emits codes.NotFound: this is a
|
|
// terminal condition (the file won't appear on retry).
|
|
func newWALNotFoundError(walName string) error {
|
|
return status.Errorf(codes.NotFound, "wal %q not found", walName)
|
|
}
|
|
|
|
// newUnavailableError reports that downloading the WAL file failed
|
|
// for a reason expected to be transient (a barman-cloud connectivity
|
|
// blip, or a generic exit code that in practice covers retryable
|
|
// conditions too). Emits codes.Unavailable: per gRPC conventions,
|
|
// the canonical signal for "retry may succeed".
|
|
func newUnavailableError(walName string, err error) error {
|
|
return status.Errorf(
|
|
codes.Unavailable,
|
|
"transient error while downloading %q: %s",
|
|
walName,
|
|
err.Error(),
|
|
)
|
|
}
|
|
|
|
// newInvalidWALNameError reports that the requested WAL name is
|
|
// not a valid name. Emits codes.InvalidArgument: this is a
|
|
// terminal condition (the same name won't become valid on retry).
|
|
func newInvalidWALNameError(walName string, err error) error {
|
|
return status.Errorf(
|
|
codes.InvalidArgument,
|
|
"invalid WAL name %q: %s",
|
|
walName,
|
|
err.Error(),
|
|
)
|
|
}
|
|
|
|
// newInternalWALRestoreError reports that downloading the WAL
|
|
// file failed for an unclassified reason. Emits codes.Internal:
|
|
// we have no positive signal that retry would help, so by gRPC
|
|
// convention this is treated as terminal.
|
|
func newInternalWALRestoreError(walName string, err error) error {
|
|
return status.Errorf(
|
|
codes.Internal,
|
|
"internal error while downloading %q: %s",
|
|
walName,
|
|
err.Error(),
|
|
)
|
|
}
|