[#121] client: Make PrmContainerDelete fields public #141
3 changed files with 80 additions and 52 deletions
|
@ -18,29 +18,33 @@ import (
|
|||
|
||||
// PrmContainerDelete groups parameters of ContainerDelete operation.
|
||||
type PrmContainerDelete struct {
|
||||
prmCommonMeta
|
||||
// FrostFS request X-Headers
|
||||
XHeaders []string
|
||||
|
||||
idSet bool
|
||||
id cid.ID
|
||||
ContainerID *cid.ID
|
||||
|
||||
tokSet bool
|
||||
tok session.Container
|
||||
Session *session.Container
|
||||
}
|
||||
|
||||
// SetContainer sets identifier of the FrostFS container to be removed.
|
||||
// Required parameter.
|
||||
func (x *PrmContainerDelete) SetContainer(id cid.ID) {
|
||||
x.id = id
|
||||
x.idSet = true
|
||||
//
|
||||
// Deprecated: Use PrmContainerDelete.Container instead.
|
||||
func (prm *PrmContainerDelete) SetContainer(id cid.ID) {
|
||||
prm.ContainerID = &id
|
||||
}
|
||||
|
||||
func (x *PrmContainerDelete) buildRequest(c *Client) (*v2container.DeleteRequest, error) {
|
||||
if !x.idSet {
|
||||
func (prm *PrmContainerDelete) buildRequest(c *Client) (*v2container.DeleteRequest, error) {
|
||||
if prm.ContainerID == nil {
|
||||
return nil, errorMissingContainer
|
||||
}
|
||||
|
||||
if len(prm.XHeaders)%2 != 0 {
|
||||
return nil, errorInvalidXHeaders
|
||||
}
|
||||
|
||||
var cidV2 refs.ContainerID
|
||||
x.id.WriteToV2(&cidV2)
|
||||
prm.ContainerID.WriteToV2(&cidV2)
|
||||
|
||||
// Container contract expects signature of container ID value,
|
||||
// don't get confused with stable marshaled protobuf container.ID structure.
|
||||
|
@ -61,11 +65,11 @@ func (x *PrmContainerDelete) buildRequest(c *Client) (*v2container.DeleteRequest
|
|||
reqBody.SetSignature(&sigv2)
|
||||
|
||||
var meta v2session.RequestMetaHeader
|
||||
writeXHeadersToMeta(x.prmCommonMeta.xHeaders, &meta)
|
||||
writeXHeadersToMeta(prm.XHeaders, &meta)
|
||||
|
||||
if x.tokSet {
|
||||
if prm.Session != nil {
|
||||
var tokv2 v2session.Token
|
||||
x.tok.WriteToV2(&tokv2)
|
||||
prm.Session.WriteToV2(&tokv2)
|
||||
|
||||
meta.SetSessionToken(&tokv2)
|
||||
}
|
||||
|
@ -82,9 +86,10 @@ func (x *PrmContainerDelete) buildRequest(c *Client) (*v2container.DeleteRequest
|
|||
// This may affect the execution of an operation (e.g. access control).
|
||||
//
|
||||
// Must be signed.
|
||||
func (x *PrmContainerDelete) WithinSession(tok session.Container) {
|
||||
x.tok = tok
|
||||
x.tokSet = true
|
||||
//
|
||||
// Deprecated: Use PrmContainerDelete.Session instead.
|
||||
func (prm *PrmContainerDelete) WithinSession(tok session.Container) {
|
||||
prm.Session = &tok
|
||||
}
|
||||
|
||||
// ResContainerDelete groups resulting values of ContainerDelete operation.
|
||||
|
|
81
pool/pool.go
81
pool/pool.go
|
@ -420,6 +420,9 @@ func (c *clientWrapper) containerPut(ctx context.Context, prm PrmContainerPut) (
|
|||
if prm.WaitParams == nil {
|
||||
prm.WaitParams = defaultWaitParams()
|
||||
}
|
||||
if err = prm.WaitParams.CheckValidity(); err != nil {
|
||||
return cid.ID{}, fmt.Errorf("invalid wait parameters: %w", err)
|
||||
}
|
||||
|
||||
idCnr := res.ID()
|
||||
|
||||
|
@ -486,10 +489,9 @@ func (c *clientWrapper) containerDelete(ctx context.Context, prm PrmContainerDel
|
|||
return err
|
||||
}
|
||||
|
||||
var cliPrm sdkClient.PrmContainerDelete
|
||||
cliPrm.SetContainer(prm.cnrID)
|
||||
if prm.stokenSet {
|
||||
cliPrm.WithinSession(prm.stoken)
|
||||
cliPrm := sdkClient.PrmContainerDelete{
|
||||
ContainerID: &prm.ContainerID,
|
||||
Session: prm.Session,
|
||||
}
|
||||
|
||||
start := time.Now()
|
||||
|
@ -503,11 +505,14 @@ func (c *clientWrapper) containerDelete(ctx context.Context, prm PrmContainerDel
|
|||
return fmt.Errorf("container delete on client: %w", err)
|
||||
}
|
||||
|
||||
if !prm.waitParamsSet {
|
||||
prm.waitParams.setDefaults()
|
||||
if prm.WaitParams == nil {
|
||||
fyrchik marked this conversation as resolved
|
||||
prm.WaitParams = defaultWaitParams()
|
||||
}
|
||||
if err := prm.WaitParams.CheckValidity(); err != nil {
|
||||
return fmt.Errorf("invalid wait parameters: %w", err)
|
||||
}
|
||||
|
||||
return waitForContainerRemoved(ctx, c, &prm.cnrID, &prm.waitParams)
|
||||
return waitForContainerRemoved(ctx, c, &prm.ContainerID, prm.WaitParams)
|
||||
}
|
||||
|
||||
// containerEACL invokes sdkClient.ContainerEACL parse response status to error and return result as is.
|
||||
|
@ -1202,39 +1207,55 @@ func (x *NodeParam) Weight() float64 {
|
|||
|
||||
// WaitParams contains parameters used in polling is a something applied on FrostFS network.
|
||||
type WaitParams struct {
|
||||
timeout time.Duration
|
||||
pollInterval time.Duration
|
||||
Timeout time.Duration
|
||||
PollInterval time.Duration
|
||||
}
|
||||
|
||||
// SetTimeout specifies the time to wait for the operation to complete.
|
||||
//
|
||||
// Deprecated: Use WaitParams.Timeout instead.
|
||||
func (x *WaitParams) SetTimeout(timeout time.Duration) {
|
||||
x.timeout = timeout
|
||||
x.Timeout = timeout
|
||||
}
|
||||
|
||||
// SetPollInterval specifies the interval, once it will check the completion of the operation.
|
||||
//
|
||||
// Deprecated: Use WaitParams.PollInterval instead.
|
||||
func (x *WaitParams) SetPollInterval(tick time.Duration) {
|
||||
x.pollInterval = tick
|
||||
x.PollInterval = tick
|
||||
}
|
||||
|
||||
// Deprecated: Use defaultWaitParams() instead.
|
||||
func (x *WaitParams) setDefaults() {
|
||||
x.timeout = 120 * time.Second
|
||||
x.pollInterval = 5 * time.Second
|
||||
x.Timeout = 120 * time.Second
|
||||
x.PollInterval = 5 * time.Second
|
||||
}
|
||||
|
||||
func defaultWaitParams() *WaitParams {
|
||||
return &WaitParams{
|
||||
timeout: 120 * time.Second,
|
||||
pollInterval: 5 * time.Second,
|
||||
Timeout: 120 * time.Second,
|
||||
PollInterval: 5 * time.Second,
|
||||
}
|
||||
}
|
||||
|
||||
// checkForPositive panics if any of the wait params isn't positive.
|
||||
func (x *WaitParams) checkForPositive() {
|
||||
if x.timeout <= 0 || x.pollInterval <= 0 {
|
||||
if x.Timeout <= 0 || x.PollInterval <= 0 {
|
||||
panic("all wait params must be positive")
|
||||
}
|
||||
}
|
||||
|
||||
// CheckForValid checks if all wait params are non-negative.
|
||||
func (x *WaitParams) CheckValidity() error {
|
||||
if x.Timeout <= 0 {
|
||||
return errors.New("timeout cannot be negative")
|
||||
}
|
||||
if x.PollInterval <= 0 {
|
||||
return errors.New("poll interval cannot be negative")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
type prmContext struct {
|
||||
defaultSession bool
|
||||
verb session.ObjectVerb
|
||||
|
@ -1464,33 +1485,35 @@ func (x *PrmContainerList) SetOwnerID(ownerID user.ID) {
|
|||
|
||||
// PrmContainerDelete groups parameters of DeleteContainer operation.
|
||||
type PrmContainerDelete struct {
|
||||
cnrID cid.ID
|
||||
ContainerID cid.ID
|
||||
|
||||
stoken session.Container
|
||||
stokenSet bool
|
||||
Session *session.Container
|
||||
|
||||
waitParams WaitParams
|
||||
waitParamsSet bool
|
||||
WaitParams *WaitParams
|
||||
}
|
||||
|
||||
// SetContainerID specifies identifier of the FrostFS container to be removed.
|
||||
//
|
||||
// Deprecated: Use PrmContainerDelete.ContainerID instead.
|
||||
func (x *PrmContainerDelete) SetContainerID(cnrID cid.ID) {
|
||||
x.cnrID = cnrID
|
||||
x.ContainerID = cnrID
|
||||
}
|
||||
|
||||
// SetSessionToken specifies session within which operation should be performed.
|
||||
//
|
||||
// Deprecated: Use PrmContainerDelete.Session instead.
|
||||
func (x *PrmContainerDelete) SetSessionToken(token session.Container) {
|
||||
x.stoken = token
|
||||
x.stokenSet = true
|
||||
x.Session = &token
|
||||
}
|
||||
|
||||
// SetWaitParams specifies timeout params to complete operation.
|
||||
// If not provided the default one will be used.
|
||||
// Panics if any of the wait params isn't positive.
|
||||
//
|
||||
// Deprecated: Use PrmContainerDelete.WaitParams instead.
|
||||
func (x *PrmContainerDelete) SetWaitParams(waitParams WaitParams) {
|
||||
waitParams.checkForPositive()
|
||||
x.waitParams = waitParams
|
||||
x.waitParamsSet = true
|
||||
x.WaitParams = &waitParams
|
||||
}
|
||||
|
||||
// PrmContainerEACL groups parameters of GetEACL operation.
|
||||
|
@ -2515,9 +2538,9 @@ func waitForContainerRemoved(ctx context.Context, cli client, cnrID *cid.ID, wai
|
|||
|
||||
// waitFor await that given condition will be met in waitParams time.
|
||||
func waitFor(ctx context.Context, params *WaitParams, condition func(context.Context) bool) error {
|
||||
wctx, cancel := context.WithTimeout(ctx, params.timeout)
|
||||
wctx, cancel := context.WithTimeout(ctx, params.Timeout)
|
||||
defer cancel()
|
||||
ticker := time.NewTimer(params.pollInterval)
|
||||
ticker := time.NewTimer(params.PollInterval)
|
||||
defer ticker.Stop()
|
||||
wdone := wctx.Done()
|
||||
done := ctx.Done()
|
||||
|
@ -2531,7 +2554,7 @@ func waitFor(ctx context.Context, params *WaitParams, condition func(context.Con
|
|||
if condition(ctx) {
|
||||
return nil
|
||||
}
|
||||
ticker.Reset(params.pollInterval)
|
||||
ticker.Reset(params.PollInterval)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -483,8 +483,8 @@ func TestWaitPresence(t *testing.T) {
|
|||
var idCnr cid.ID
|
||||
|
||||
err := waitForContainerPresence(ctx, mockCli, idCnr, &WaitParams{
|
||||
timeout: 120 * time.Second,
|
||||
pollInterval: 5 * time.Second,
|
||||
Timeout: 120 * time.Second,
|
||||
PollInterval: 5 * time.Second,
|
||||
})
|
||||
require.Error(t, err)
|
||||
require.Contains(t, err.Error(), "context canceled")
|
||||
|
@ -494,8 +494,8 @@ func TestWaitPresence(t *testing.T) {
|
|||
ctx := context.Background()
|
||||
var idCnr cid.ID
|
||||
err := waitForContainerPresence(ctx, mockCli, idCnr, &WaitParams{
|
||||
timeout: 500 * time.Millisecond,
|
||||
pollInterval: 5 * time.Second,
|
||||
Timeout: 500 * time.Millisecond,
|
||||
PollInterval: 5 * time.Second,
|
||||
})
|
||||
require.Error(t, err)
|
||||
require.Contains(t, err.Error(), "context deadline exceeded")
|
||||
|
@ -505,8 +505,8 @@ func TestWaitPresence(t *testing.T) {
|
|||
ctx := context.Background()
|
||||
var idCnr cid.ID
|
||||
err := waitForContainerPresence(ctx, mockCli, idCnr, &WaitParams{
|
||||
timeout: 10 * time.Second,
|
||||
pollInterval: 500 * time.Millisecond,
|
||||
Timeout: 10 * time.Second,
|
||||
PollInterval: 500 * time.Millisecond,
|
||||
})
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
|
Loading…
Reference in a new issue
Won't private fields be a problem here too?
Sorry, I didn't get the point.
prm.WaitParams
is no longer privateYes, but the
WaitParams
itself has private fields. I think making them public aligns well with the overall goal.Oh. You're right. I'll fix it