node: Process API client errors according to NeoFS SDK RC-9 docs

Currently used SDK revision changed/improved docs and UX of error handling. Storage node missed these changes on SDK upgrade, so we have to adjust to them. Use `errors.Is` when exact error structure is not needed. Actualize docs of errors returned by internal client. Fixes #2465. Signed-off-by: Leonard Lyubich <[email protected]>
nspcc-dev · Aug 8, 2023 · a6bcf16 · a6bcf16
1 parent 4a0198f
commit a6bcf16
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 21 deletions.
diff --git a/pkg/services/object/get/remote.go b/pkg/services/object/get/remote.go
@@ -21,15 +21,11 @@ func (exec *execCtx) processNode(ctx context.Context, info client.NodeInfo) bool
 	obj, err := client.getObject(exec, info)
 
 	var errSplitInfo *objectSDK.SplitInfoError
-	var errRemoved *apistatus.ObjectAlreadyRemoved
-	var errOutOfRange *apistatus.ObjectOutOfRange
 
 	switch {
 	default:
-		var errNotFound apistatus.ObjectNotFound
-
 		exec.status = statusUndefined
-		exec.err = errNotFound
+		exec.err = apistatus.ErrObjectNotFound
 
 		exec.log.Debug("remote call failed",
 			zap.String("error", err.Error()),
@@ -45,12 +41,12 @@ func (exec *execCtx) processNode(ctx context.Context, info client.NodeInfo) bool
 			exec.collectedObject = obj
 			exec.writeCollectedObject()
 		}
-	case errors.As(err, &errRemoved):
+	case errors.Is(err, apistatus.ErrObjectAlreadyRemoved):
 		exec.status = statusINHUMED
-		exec.err = errRemoved
-	case errors.As(err, &errOutOfRange):
+		exec.err = err
+	case errors.Is(err, apistatus.ErrObjectOutOfRange):
 		exec.status = statusOutOfRange
-		exec.err = errOutOfRange
+		exec.err = err
 	case errors.As(err, &errSplitInfo):
 		exec.status = statusVIRTUAL
 		mergeSplitInfo(exec.splitInfo(), errSplitInfo.SplitInfo())

diff --git a/pkg/services/object/get/util.go b/pkg/services/object/get/util.go
@@ -142,8 +142,7 @@ func (c *clientWrapper) getObject(exec *execCtx, info coreclient.NodeInfo) (*obj
 
 		res, err := internalclient.PayloadRange(prm)
 		if err != nil {
-			var errAccessDenied *apistatus.ObjectAccessDenied
-			if errors.As(err, &errAccessDenied) {
+			if errors.Is(err, apistatus.ErrObjectAccessDenied) {
 				// Current spec allows other storage node to deny access,
 				// fallback to GET here.
 				obj, err := c.get(exec, key)

diff --git a/pkg/services/object/head/remote.go b/pkg/services/object/head/remote.go
@@ -63,7 +63,9 @@ func (p *RemoteHeadPrm) WithObjectAddress(v oid.Address) *RemoteHeadPrm {
 	return p
 }
 
-// Head requests object header from the remote node.
+// Head requests object header from the remote node. Returns:
+//   - [apistatus.ErrObjectNotFound] error if the requested object is missing
+//   - [apistatus.ErrNodeUnderMaintenance] error if remote node is currently under maintenance
 func (h *RemoteHeader) Head(ctx context.Context, prm *RemoteHeadPrm) (*object.Object, error) {
 	key, err := h.keyStorage.GetKey(nil)
 	if err != nil {

diff --git a/pkg/services/object/internal/client/client.go b/pkg/services/object/internal/client/client.go
@@ -134,8 +134,8 @@ func (x GetObjectRes) Object() *object.Object {
 //
 // Returns any error which prevented the operation from completing correctly in error return.
 // Returns:
-//   - error of type *object.SplitInfoError if object raw flag is set and requested object is virtual;
-//   - error of type *apistatus.ObjectAlreadyRemoved if the requested object is marked to be removed.
+//   - error of type *object.SplitInfoError if object raw flag is set and requested object is virtual
+//   - [apistatus.ErrObjectAlreadyRemoved] error if the requested object is marked to be removed
 //
 // GetObject ignores the provided session if it is not related to the requested object.
 func GetObject(prm GetObjectPrm) (*GetObjectRes, error) {
@@ -228,9 +228,9 @@ func (x HeadObjectRes) Header() *object.Object {
 //
 // Returns any error which prevented the operation from completing correctly in error return.
 // Returns:
-//
-//	error of type *object.SplitInfoError if object raw flag is set and requested object is virtual;
-//	error of type *apistatus.ObjectAlreadyRemoved if the requested object is marked to be removed.
+//   - error of type *object.SplitInfoError if object raw flag is set and requested object is virtual
+//   - [apistatus.ErrObjectAlreadyRemoved] error if the requested object is marked to be removed
+//   - [apistatus.ErrNodeUnderMaintenance] error if remote node is currently under maintenance
 //
 // HeadObject ignores the provided session if it is not related to the requested object.
 func HeadObject(prm HeadObjectPrm) (*HeadObjectRes, error) {
@@ -321,10 +321,10 @@ const maxInitialBufferSize = 1024 * 1024 // 1 MiB
 //
 // Returns any error which prevented the operation from completing correctly in error return.
 // Returns:
-//
-//	error of type *object.SplitInfoError if object raw flag is set and requested object is virtual;
-//	error of type *apistatus.ObjectAlreadyRemoved if the requested object is marked to be removed;
-//	error of type *apistatus.ObjectOutOfRange if the requested range is too big.
+//   - error of type *object.SplitInfoError if object raw flag is set and requested object is virtual
+//   - [apistatus.ErrObjectAlreadyRemoved] error if the requested object is marked to be removed
+//   - [apistatus.ErrObjectOutOfRange] error if the requested range is too big
+//   - [apistatus.ErrObjectAccessDenied] error if access to the requested object is denied
 //
 // PayloadRange ignores the provided session if it is not related to the requested object.
 func PayloadRange(prm PayloadRangePrm) (*PayloadRangeRes, error) {