mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-07-07 02:02:21 +02:00
d30bbdfae3
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>
85 lines
2.7 KiB
Go
85 lines
2.7 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 returns an error indicating that the
|
|
// requested WAL file is not present in the object store.
|
|
// It carries a gRPC NotFound status so the operator can
|
|
// treat it as a terminal condition.
|
|
func newWALNotFoundError(walName string) error {
|
|
return status.Errorf(codes.NotFound, "wal %q not found", walName)
|
|
}
|
|
|
|
// newUnavailableError returns an error indicating that
|
|
// downloading the given WAL file failed for a transient
|
|
// reason (e.g. a connectivity blip). It carries a gRPC
|
|
// Unavailable status so the operator will retry the
|
|
// request.
|
|
func newUnavailableError(walName string, err error) error {
|
|
return status.Errorf(
|
|
codes.Unavailable,
|
|
"transient error while downloading %q: %s",
|
|
walName,
|
|
err.Error(),
|
|
)
|
|
}
|
|
|
|
// newInvalidWALNameError returns an error indicating that
|
|
// the requested WAL name is not valid. It carries a gRPC
|
|
// InvalidArgument status so the operator treats it as a
|
|
// terminal condition.
|
|
func newInvalidWALNameError(walName string, err error) error {
|
|
return status.Errorf(
|
|
codes.InvalidArgument,
|
|
"invalid WAL name %q: %s",
|
|
walName,
|
|
err.Error(),
|
|
)
|
|
}
|
|
|
|
// newInternalWALRestoreError returns an error indicating
|
|
// that downloading the given WAL file failed for an
|
|
// unclassified reason. It carries a gRPC Internal status
|
|
// so the operator treats it as a terminal condition.
|
|
func newInternalWALRestoreError(walName string, err error) error {
|
|
return status.Errorf(
|
|
codes.Internal,
|
|
"internal error while downloading %q: %s",
|
|
walName,
|
|
err.Error(),
|
|
)
|
|
}
|