From 9727beb47d02a53cdecf91053f819fac183e7331 Mon Sep 17 00:00:00 2001 From: Egor Olefirenko Date: Tue, 12 Sep 2023 18:57:04 +0300 Subject: [PATCH] [#131] client: Switch ResolveFrostFSFailures to DontResolveFrostFSFailures option Signed-off-by: Egor Olefirenko --- README.md | 6 +++--- client/accounting.go | 6 +++--- client/client.go | 14 +++++++------- client/common.go | 2 +- client/container_delete.go | 6 +++--- client/container_eacl.go | 6 +++--- client/container_get.go | 6 +++--- client/container_list.go | 6 +++--- client/container_put.go | 6 +++--- client/container_set_eacl.go | 6 +++--- client/container_space.go | 6 +++--- client/netmap.go | 18 +++++++++--------- client/object_delete.go | 6 +++--- client/object_get.go | 6 +++--- client/object_hash.go | 6 +++--- client/object_put_transformer.go | 4 ++-- client/session.go | 6 +++--- 17 files changed, 58 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index e898e49..30fb6aa 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Contains client for working with FrostFS. ```go var prmInit client.PrmInit prmInit.SetDefaultPrivateKey(key) // private key for request signing -prmInit.ResolveFrostFSFailures() // enable erroneous status parsing +prmInit.DontResolveFrostFSFailures() // disable erroneous status parsing var c client.Client c.Init(prmInit) @@ -77,8 +77,8 @@ if needed and perform any desired action. In the case above we may want to repor these details to the user as well as retry an operation, possibly with different parameters. Status wire-format is extendable and each node can report any set of details it wants. The set of reserved status codes can be found in -[FrostFS API](https://git.frostfs.info/TrueCloudLab/frostfs-api/src/branch/master/status/types.proto). There is also -a `client.PrmInit.ResolveFrostFSFailures()` to seamlessly convert erroneous statuses into Go error type. +[FrostFS API](https://git.frostfs.info/TrueCloudLab/frostfs-api/src/branch/master/status/types.proto). +Use `client.PrmInit.DontResolveFrostFSFailures()` to avoid returning erroneous statuses as Go built-in errors. ### policy Contains helpers allowing conversion of placing policy from/to JSON representation diff --git a/client/accounting.go b/client/accounting.go index a35fcb1..b59deb0 100644 --- a/client/accounting.go +++ b/client/accounting.go @@ -64,9 +64,9 @@ func (x ResBalanceGet) Amount() accounting.Decimal { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`, -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmBalanceGet docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/client.go b/client/client.go index 3942390..310ab8d 100644 --- a/client/client.go +++ b/client/client.go @@ -144,7 +144,7 @@ func (c *Client) Close() error { // // See also Init. type PrmInit struct { - resolveFrostFSErrors bool + dontResolveFrostFSErrors bool key ecdsa.PrivateKey @@ -161,12 +161,12 @@ func (x *PrmInit) SetDefaultPrivateKey(key ecdsa.PrivateKey) { x.key = key } -// ResolveFrostFSFailures makes the Client to resolve failure statuses of the -// FrostFS protocol into Go built-in errors. These errors are returned from -// each protocol operation. By default, statuses aren't resolved and written -// to the resulting structure (see corresponding Res* docs). -func (x *PrmInit) ResolveFrostFSFailures() { - x.resolveFrostFSErrors = true +// DontResolveFrostFSFailures makes the Client to preserve failure statuses of the +// FrostFS protocol only in resulting structure (see corresponding Res* docs). +// These errors are returned from each protocol operation. By default, statuses +// are resolved and returned as a Go built-in errors. +func (x *PrmInit) DontResolveFrostFSFailures() { + x.dontResolveFrostFSErrors = true } // SetResponseInfoCallback makes the Client to pass ResponseMetaInfo from each diff --git a/client/common.go b/client/common.go index 3895b00..ff08bf2 100644 --- a/client/common.go +++ b/client/common.go @@ -119,7 +119,7 @@ func (c *Client) processResponse(resp responseV2) (apistatus.Status, error) { } st := apistatus.FromStatusV2(resp.GetMetaHeader().GetStatus()) - if c.prm.resolveFrostFSErrors { + if !c.prm.dontResolveFrostFSErrors { return st, apistatus.ErrFromStatus(st) } return st, nil diff --git a/client/container_delete.go b/client/container_delete.go index 181c15b..43ddec7 100644 --- a/client/container_delete.go +++ b/client/container_delete.go @@ -101,9 +101,9 @@ type ResContainerDelete struct { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Operation is asynchronous and no guaranteed even in the absence of errors. // The required time is also not predictable. diff --git a/client/container_eacl.go b/client/container_eacl.go index 2acde86..b28ad52 100644 --- a/client/container_eacl.go +++ b/client/container_eacl.go @@ -68,9 +68,9 @@ func (x ResContainerEACL) Table() eacl.Table { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmContainerEACL docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/container_get.go b/client/container_get.go index d2ef0fe..72961b2 100644 --- a/client/container_get.go +++ b/client/container_get.go @@ -71,9 +71,9 @@ func (x ResContainerGet) Container() container.Container { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmContainerGet docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/container_list.go b/client/container_list.go index eb8cc88..48684b1 100644 --- a/client/container_list.go +++ b/client/container_list.go @@ -65,9 +65,9 @@ func (x ResContainerList) Containers() []cid.ID { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmContainerList docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/container_put.go b/client/container_put.go index f186abd..5e026d3 100644 --- a/client/container_put.go +++ b/client/container_put.go @@ -110,9 +110,9 @@ func (x ResContainerPut) ID() cid.ID { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Operation is asynchronous and no guaranteed even in the absence of errors. // The required time is also not predictable. diff --git a/client/container_set_eacl.go b/client/container_set_eacl.go index 0ea89aa..af0ce3c 100644 --- a/client/container_set_eacl.go +++ b/client/container_set_eacl.go @@ -101,9 +101,9 @@ type ResContainerSetEACL struct { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Operation is asynchronous and no guaranteed even in the absence of errors. // The required time is also not predictable. diff --git a/client/container_space.go b/client/container_space.go index c066c0a..bc11bc8 100644 --- a/client/container_space.go +++ b/client/container_space.go @@ -57,9 +57,9 @@ type ResAnnounceSpace struct { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Operation is asynchronous and no guaranteed even in the absence of errors. // The required time is also not predictable. diff --git a/client/netmap.go b/client/netmap.go index 80d1ded..0e72233 100644 --- a/client/netmap.go +++ b/client/netmap.go @@ -53,9 +53,9 @@ func (x ResEndpointInfo) NodeInfo() netmap.NodeInfo { // Method can be used as a health check to see if node is alive and responds to requests. // // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmEndpointInfo docs). // Context is required and must not be nil. It is used for network communication. @@ -140,9 +140,9 @@ func (x ResNetworkInfo) Info() netmap.NetworkInfo { // NetworkInfo requests information about the FrostFS network of which the remote server is a part. // // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmNetworkInfo docs). // Context is required and must not be nil. It is used for network communication. @@ -204,9 +204,9 @@ func (x ResNetMapSnapshot) NetMap() netmap.NetMap { // NetMapSnapshot requests current network view of the remote server. // // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly. // Context is required and MUST NOT be nil. It is used for network communication. diff --git a/client/object_delete.go b/client/object_delete.go index 993cd5d..a535752 100644 --- a/client/object_delete.go +++ b/client/object_delete.go @@ -112,9 +112,9 @@ func (prm *PrmObjectDelete) buildRequest(c *Client) (*v2object.DeleteRequest, er // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`, -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmObjectDelete docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/object_get.go b/client/object_get.go index 56cbfda..fcf5e24 100644 --- a/client/object_get.go +++ b/client/object_get.go @@ -444,9 +444,9 @@ func (prm *PrmObjectHead) buildRequest(c *Client) (*v2object.HeadRequest, error) // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`, -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmObjectHead docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/object_hash.go b/client/object_hash.go index 7fdf335..2a99426 100644 --- a/client/object_hash.go +++ b/client/object_hash.go @@ -152,9 +152,9 @@ func (prm *PrmObjectHash) buildRequest(c *Client) (*v2object.GetRangeHashRequest // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`, -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmObjectHash docs). // Context is required and must not be nil. It is used for network communication. diff --git a/client/object_put_transformer.go b/client/object_put_transformer.go index 9013348..a4d2f80 100644 --- a/client/object_put_transformer.go +++ b/client/object_put_transformer.go @@ -83,7 +83,7 @@ func (it *internalTarget) putAsStream(ctx context.Context, o *object.Object) err wrt.WritePayloadChunk(ctx, o.Payload()) } it.res, err = wrt.Close(ctx) - if err == nil && !it.client.prm.resolveFrostFSErrors && !apistatus.IsSuccessful(it.res.st) { + if err == nil && it.client.prm.dontResolveFrostFSErrors && !apistatus.IsSuccessful(it.res.st) { err = apistatus.ErrFromStatus(it.res.st) } return err @@ -115,7 +115,7 @@ func (it *internalTarget) tryPutSingle(ctx context.Context, o *object.Object) (b statusRes: res.statusRes, obj: id, } - if !it.client.prm.resolveFrostFSErrors && !apistatus.IsSuccessful(it.res.st) { + if it.client.prm.dontResolveFrostFSErrors && !apistatus.IsSuccessful(it.res.st) { return true, apistatus.ErrFromStatus(it.res.st) } return true, nil diff --git a/client/session.go b/client/session.go index b3ec722..12cb2a1 100644 --- a/client/session.go +++ b/client/session.go @@ -89,9 +89,9 @@ func (x ResSessionCreate) PublicKey() []byte { // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`. -// If PrmInit.ResolveFrostFSFailures has been called, unsuccessful -// FrostFS status codes are returned as `error`, otherwise, are included -// in the returned result structure. +// If PrmInit.DontResolveFrostFSFailures has been called, unsuccessful +// FrostFS status codes are included in the returned result structure, +// otherwise, are also returned as `error`. // // Returns an error if parameters are set incorrectly (see PrmSessionCreate docs). // Context is required and must not be nil. It is used for network communication.