From 0d79d1048216fd47b969541048e474fdede1a009 Mon Sep 17 00:00:00 2001 From: Egor Olefirenko Date: Fri, 15 Sep 2023 18:52:08 +0300 Subject: [PATCH] [#131] client: rename option consistently and fix test Signed-off-by: Egor Olefirenko --- README.md | 4 ++-- client/accounting.go | 2 +- client/client.go | 8 ++++---- client/common.go | 2 +- client/container_delete.go | 2 +- client/container_eacl.go | 2 +- client/container_get.go | 2 +- client/container_list.go | 2 +- client/container_put.go | 2 +- client/container_set_eacl.go | 2 +- client/container_space.go | 2 +- client/netmap.go | 6 +++--- client/netmap_test.go | 1 + client/object_delete.go | 2 +- client/object_get.go | 2 +- client/object_hash.go | 2 +- client/object_put_transformer.go | 4 ++-- client/session.go | 2 +- 18 files changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 30fb6aa..23704fb 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.DontResolveFrostFSFailures() // disable erroneous status parsing +prmInit.DisableFrostFSFailuresResolution() // disable erroneous status parsing var c client.Client c.Init(prmInit) @@ -78,7 +78,7 @@ these details to the user as well as retry an operation, possibly with different 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). -Use `client.PrmInit.DontResolveFrostFSFailures()` to avoid returning erroneous statuses as Go built-in errors. +Use `client.PrmInit.DisableFrostFSFailuresResolution()` 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 b59deb0..402554f 100644 --- a/client/accounting.go +++ b/client/accounting.go @@ -64,7 +64,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/client.go b/client/client.go index 310ab8d..f1dacf1 100644 --- a/client/client.go +++ b/client/client.go @@ -144,7 +144,7 @@ func (c *Client) Close() error { // // See also Init. type PrmInit struct { - dontResolveFrostFSErrors bool + disableFrostFSErrorResolution bool key ecdsa.PrivateKey @@ -161,12 +161,12 @@ func (x *PrmInit) SetDefaultPrivateKey(key ecdsa.PrivateKey) { x.key = key } -// DontResolveFrostFSFailures makes the Client to preserve failure statuses of the +// DisableFrostFSFailuresResolution 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 +func (x *PrmInit) DisableFrostFSFailuresResolution() { + x.disableFrostFSErrorResolution = true } // SetResponseInfoCallback makes the Client to pass ResponseMetaInfo from each diff --git a/client/common.go b/client/common.go index ff08bf2..ac9feb0 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.dontResolveFrostFSErrors { + if !c.prm.disableFrostFSErrorResolution { return st, apistatus.ErrFromStatus(st) } return st, nil diff --git a/client/container_delete.go b/client/container_delete.go index 43ddec7..f750c90 100644 --- a/client/container_delete.go +++ b/client/container_delete.go @@ -101,7 +101,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/container_eacl.go b/client/container_eacl.go index b28ad52..d577b7a 100644 --- a/client/container_eacl.go +++ b/client/container_eacl.go @@ -68,7 +68,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/container_get.go b/client/container_get.go index 72961b2..4477973 100644 --- a/client/container_get.go +++ b/client/container_get.go @@ -71,7 +71,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/container_list.go b/client/container_list.go index 48684b1..4197d3d 100644 --- a/client/container_list.go +++ b/client/container_list.go @@ -65,7 +65,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/container_put.go b/client/container_put.go index 5e026d3..6ff4e5f 100644 --- a/client/container_put.go +++ b/client/container_put.go @@ -110,7 +110,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/container_set_eacl.go b/client/container_set_eacl.go index af0ce3c..8ad808f 100644 --- a/client/container_set_eacl.go +++ b/client/container_set_eacl.go @@ -101,7 +101,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/container_space.go b/client/container_space.go index bc11bc8..793f5f4 100644 --- a/client/container_space.go +++ b/client/container_space.go @@ -57,7 +57,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/netmap.go b/client/netmap.go index 0e72233..c06f940 100644 --- a/client/netmap.go +++ b/client/netmap.go @@ -53,7 +53,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // @@ -140,7 +140,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // @@ -204,7 +204,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/netmap_test.go b/client/netmap_test.go index 76920a1..4ec931e 100644 --- a/client/netmap_test.go +++ b/client/netmap_test.go @@ -84,6 +84,7 @@ func TestClient_NetMapSnapshot(t *testing.T) { srv.signResponse = true // status failure + c.prm.DisableFrostFSFailuresResolution() res, err = c.NetMapSnapshot(ctx, prm) require.NoError(t, err) assertStatusErr(t, res) diff --git a/client/object_delete.go b/client/object_delete.go index a535752..3f72e0c 100644 --- a/client/object_delete.go +++ b/client/object_delete.go @@ -112,7 +112,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/object_get.go b/client/object_get.go index fcf5e24..03b91d2 100644 --- a/client/object_get.go +++ b/client/object_get.go @@ -444,7 +444,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/object_hash.go b/client/object_hash.go index 2a99426..e65e948 100644 --- a/client/object_hash.go +++ b/client/object_hash.go @@ -152,7 +152,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. // diff --git a/client/object_put_transformer.go b/client/object_put_transformer.go index a4d2f80..357e94f 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.dontResolveFrostFSErrors && !apistatus.IsSuccessful(it.res.st) { + if err == nil && it.client.prm.disableFrostFSErrorResolution && !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.dontResolveFrostFSErrors && !apistatus.IsSuccessful(it.res.st) { + if it.client.prm.disableFrostFSErrorResolution && !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 12cb2a1..03ed5e8 100644 --- a/client/session.go +++ b/client/session.go @@ -89,7 +89,7 @@ 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.DontResolveFrostFSFailures has been called, unsuccessful +// If PrmInit.DisableFrostFSFailuresResolution has been called, unsuccessful // FrostFS status codes are included in the returned result structure, // otherwise, are also returned as `error`. //