Skip to content

Get metadata consistency policy from contract #1150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 5, 2025
Merged

Get metadata consistency policy from contract #1150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api/handler/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ type (
NotificatorEnabled bool
CopiesNumber uint32
MaxDeletePerRequest int
ContainerMetadataPolicy string
}

PlacementPolicy interface {
Expand All @@ -46,7 +47,7 @@ type (
PlacementPolicyProvider interface {
// GetPlacementPolicy get policy by name.
// Returns [models.ErrNotFound] if policy not found.
GetPlacementPolicy(userAddr util.Uint160, policyName string) (*netmap.PlacementPolicy, error)
GetPlacementPolicy(userAddr util.Uint160, policyName string) (*layer.PlacementPolicy, error)
}

// ACLStateProvider get bucket ACL state.
Expand Down
18 changes: 15 additions & 3 deletions api/handler/put.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -825,20 +825,32 @@ func (h *handler) CreateBucketHandler(w http.ResponseWriter, r *http.Request) {
}

func (h handler) setPolicy(prm *layer.CreateBucketParams, userAddr util.Uint160, locationConstraint string, userPolicies []*accessbox.ContainerPolicy) {
prm.Policy = h.cfg.Policy.Default()
prm.Policy = layer.PlacementPolicy{
Version: layer.PlacementPolicyV1,
Placement: h.cfg.Policy.Default(),
Consistency: h.cfg.ContainerMetadataPolicy,
}

if locationConstraint == "" {
return
}

if policy, ok := h.cfg.Policy.Get(locationConstraint); ok {
prm.Policy = policy
prm.Policy = layer.PlacementPolicy{
Version: layer.PlacementPolicyV1,
Placement: policy,
Consistency: h.cfg.ContainerMetadataPolicy,
}
prm.LocationConstraint = locationConstraint
}

for _, placementPolicy := range userPolicies {
if placementPolicy.LocationConstraint == locationConstraint {
prm.Policy = placementPolicy.Policy
prm.Policy = layer.PlacementPolicy{
Version: layer.PlacementPolicyV1,
Placement: placementPolicy.Policy,
Consistency: h.cfg.ContainerMetadataPolicy,
}
prm.LocationConstraint = locationConstraint
return
}
Expand Down
10 changes: 9 additions & 1 deletion api/layer/layer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ type (
// CreateBucketParams stores bucket create request parameters.
CreateBucketParams struct {
Name string
Policy netmap.PlacementPolicy
Policy PlacementPolicy
EACL *eacl.Table
SessionContainerCreation *session.Container
SessionEACL *session.Container
Expand Down Expand Up @@ -211,6 +211,12 @@ type (
ObjectInfo *data.ObjectInfo
}

PlacementPolicy struct {
Version int
Placement netmap.PlacementPolicy
Consistency string
}

// Client provides S3 API client interface.
Client interface {
Initialize(ctx context.Context, c EventListener) error
Expand Down Expand Up @@ -281,6 +287,8 @@ const (
AESEncryptionAlgorithm = "AES256"
AESKeySize = 32
AttributeNeofsCopiesNumber = "neofs-copies-number" // such format to match X-Amz-Meta-Neofs-Copies-Number header

PlacementPolicyV1 = 1
)

var (
Expand Down
3 changes: 1 addition & 2 deletions api/layer/neofs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import (
"github.com/nspcc-dev/neofs-sdk-go/container/acl"
cid "github.com/nspcc-dev/neofs-sdk-go/container/id"
"github.com/nspcc-dev/neofs-sdk-go/eacl"
"github.com/nspcc-dev/neofs-sdk-go/netmap"
"github.com/nspcc-dev/neofs-sdk-go/object"
oid "github.com/nspcc-dev/neofs-sdk-go/object/id"
"github.com/nspcc-dev/neofs-sdk-go/session"
Expand All @@ -31,7 +30,7 @@ type PrmContainerCreate struct {
CreatorPubKey keys.PublicKey

// Container placement policy.
Policy netmap.PlacementPolicy
Policy PlacementPolicy

// Name for the container.
Name string
Expand Down
2 changes: 1 addition & 1 deletion api/layer/neofs_mock.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func (t *TestNeoFS) CreateContainer(_ context.Context, prm PrmContainerCreate) (
var cnr container.Container
cnr.Init()
cnr.SetOwner(prm.Creator)
cnr.SetPlacementPolicy(prm.Policy)
cnr.SetPlacementPolicy(prm.Policy.Placement)
cnr.SetBasicACL(prm.BasicACL)

creationTime := prm.CreationTime
Expand Down
10 changes: 10 additions & 0 deletions cmd/s3-gw/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -800,6 +800,16 @@ func (a *App) initHandler() {
cfg.MaxDeletePerRequest = defaultMaxObjectDeletePerRequest
}

cfg.ContainerMetadataPolicy = a.cfg.GetString(cfgContainerMetadataPolicy)

switch cfg.ContainerMetadataPolicy {
case neofs.ContainerMetaDataPolicyOptimistic:
case neofs.ContainerMetaDataPolicyStrict:
case "":
default:
a.log.Fatal("unsupported config value", zap.String("option", cfgContainerMetadataPolicy))
}

var err error
a.api, err = handler.New(a.log, a.obj, a.nc, cfg)
if err != nil {
Expand Down
6 changes: 3 additions & 3 deletions cmd/s3-gw/storage_policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"sync"

"github.com/nspcc-dev/neo-go/pkg/util"
"github.com/nspcc-dev/neofs-sdk-go/netmap"
"github.com/nspcc-dev/neofs-s3-gw/api/layer"
)

type (
Expand All @@ -14,7 +14,7 @@ type (
}

servicePolicyProvider interface {
GetPlacementPolicy(userAddr util.Uint160, policyName string) (*netmap.PlacementPolicy, error)
GetPlacementPolicy(userAddr util.Uint160, policyName string) (*layer.PlacementPolicy, error)
}
)

Expand All @@ -25,7 +25,7 @@ func newStoragePolicyService(provider servicePolicyProvider) *storagePolicyServi
}
}

func (s *storagePolicyService) GetPlacementPolicy(userAddr util.Uint160, policyName string) (*netmap.PlacementPolicy, error) {
func (s *storagePolicyService) GetPlacementPolicy(userAddr util.Uint160, policyName string) (*layer.PlacementPolicy, error) {
s.mu.RLock()
defer s.mu.RUnlock()

Expand Down
28 changes: 23 additions & 5 deletions cmd/s3-gw/storage_policy_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"context"
"encoding/json"
"errors"
"fmt"
"strings"
Expand All @@ -12,6 +13,7 @@ import (
"github.com/nspcc-dev/neo-go/pkg/rpcclient/unwrap"
"github.com/nspcc-dev/neo-go/pkg/util"
rpcNNS "github.com/nspcc-dev/neofs-contract/rpc/nns"
"github.com/nspcc-dev/neofs-s3-gw/api/layer"
"github.com/nspcc-dev/neofs-s3-gw/internal/models"
"github.com/nspcc-dev/neofs-sdk-go/netmap"
)
Expand Down Expand Up @@ -80,7 +82,7 @@ func resolveContract(cl *rpcclient.Client, inv *invoker.Invoker, contractName st
return contractHash, nil
}

func (p *storagePolicyProvider) GetPlacementPolicy(userAddr util.Uint160, policyName string) (*netmap.PlacementPolicy, error) {
func (p *storagePolicyProvider) GetPlacementPolicy(userAddr util.Uint160, policyName string) (*layer.PlacementPolicy, error) {
payload, err := unwrap.Bytes(
p.invoker().Call(p.contractHash, "resolvePolicy", userAddr, policyName),
)
Expand All @@ -93,12 +95,28 @@ func (p *storagePolicyProvider) GetPlacementPolicy(userAddr util.Uint160, policy
return nil, fmt.Errorf("get system storage policy: %w", err)
}

var pp netmap.PlacementPolicy
if err = pp.UnmarshalJSON(payload); err != nil {
var (
policy layer.PlacementPolicy
pp netmap.PlacementPolicy
)

if err = json.Unmarshal(payload, &policy); err != nil {
return nil, fmt.Errorf("unmarshal placement policy: %w", err)
}

return &pp, nil
switch policy.Version {
case layer.PlacementPolicyV1:
return &policy, nil
default:
if err = pp.UnmarshalJSON(payload); err != nil {
return nil, fmt.Errorf("unmarshal placement policy: %w", err)
}

policy.Placement = pp
policy.Version = layer.PlacementPolicyV1
}

return &policy, nil
}

func (p *storagePolicyProvider) index() int {
Expand Down Expand Up @@ -133,6 +151,6 @@ func rpcClient(ctx context.Context, endpoint string) (*rpcclient.Client, error)
return cl, nil
}

func (p *noOpStoragePolicyProvider) GetPlacementPolicy(_ util.Uint160, _ string) (*netmap.PlacementPolicy, error) {
func (p *noOpStoragePolicyProvider) GetPlacementPolicy(_ util.Uint160, _ string) (*layer.PlacementPolicy, error) {
return nil, models.ErrNotFound
}
10 changes: 5 additions & 5 deletions internal/neofs/neofs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ func (x *NeoFS) CreateContainer(ctx context.Context, prm layer.PrmContainerCreat

var cnr container.Container
cnr.Init()
cnr.SetPlacementPolicy(prm.Policy)
cnr.SetPlacementPolicy(prm.Policy.Placement)
cnr.SetOwner(prm.Creator)
cnr.SetBasicACL(prm.BasicACL)

Expand Down Expand Up @@ -181,9 +181,9 @@ func (x *NeoFS) CreateContainer(ctx context.Context, prm layer.PrmContainerCreat

cnr.SetAttribute(layer.AttributeOwnerPublicKey, hex.EncodeToString(prm.CreatorPubKey.Bytes()))

if x.cfg.ContainerMetadataPolicy == ContainerMetaDataPolicyStrict ||
x.cfg.ContainerMetadataPolicy == ContainerMetaDataPolicyOptimistic {
cnr.SetAttribute(containerMetaDataPolicyAttribute, x.cfg.ContainerMetadataPolicy)
if prm.Policy.Consistency == ContainerMetaDataPolicyStrict ||
prm.Policy.Consistency == ContainerMetaDataPolicyOptimistic {
cnr.SetAttribute(containerMetaDataPolicyAttribute, prm.Policy.Consistency)
}

err := client.SyncContainerWithNetwork(ctx, &cnr, x.pool)
Expand Down Expand Up @@ -688,7 +688,7 @@ func (x *AuthmateNeoFS) CreateContainer(ctx context.Context, prm authmate.PrmCon

return x.neoFS.CreateContainer(ctx, layer.PrmContainerCreate{
Creator: prm.Owner,
Policy: prm.Policy,
Policy: layer.PlacementPolicy{Placement: prm.Policy, Version: layer.PlacementPolicyV1},
Name: prm.FriendlyName,
BasicACL: basicACL,
CreatorPubKey: prm.CreatorPubKey,
Expand Down
Loading