[#488] reputation/managers: Implement route builders

Add implementation of Builder interface for
intermediate trusts. Move all code associated
with managers to `common` directory in `cmd`
and `pkg/services/reputation`

Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
This commit is contained in:
Pavel Karpy 2021-04-22 17:56:25 +03:00 committed by Alex Vanin
parent 6ffc109a75
commit 49d477f466
9 changed files with 106 additions and 31 deletions

View file

@ -1,4 +1,4 @@
package local package common
import ( import (
"bytes" "bytes"
@ -7,8 +7,8 @@ import (
apiNetmap "github.com/nspcc-dev/neofs-api-go/pkg/netmap" apiNetmap "github.com/nspcc-dev/neofs-api-go/pkg/netmap"
netmapcore "github.com/nspcc-dev/neofs-node/pkg/core/netmap" netmapcore "github.com/nspcc-dev/neofs-node/pkg/core/netmap"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation" "github.com/nspcc-dev/neofs-node/pkg/services/reputation"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation/common"
reputationrouter "github.com/nspcc-dev/neofs-node/pkg/services/reputation/common/router" reputationrouter "github.com/nspcc-dev/neofs-node/pkg/services/reputation/common/router"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation/local/managers"
"github.com/nspcc-dev/neofs-node/pkg/util/logger" "github.com/nspcc-dev/neofs-node/pkg/util/logger"
"go.uber.org/zap" "go.uber.org/zap"
) )
@ -36,10 +36,10 @@ type ManagersPrm struct {
// //
// The created managerBuilder does not require additional // The created managerBuilder does not require additional
// initialization and is completely ready for work. // initialization and is completely ready for work.
func NewManagerBuilder(prm ManagersPrm, opts ...MngOption) managers.ManagerBuilder { func NewManagerBuilder(prm ManagersPrm, opts ...MngOption) common.ManagerBuilder {
switch { switch {
case prm.NetMapSource == nil: case prm.NetMapSource == nil:
panicOnPrmValue("NetMapSource", prm.NetMapSource) PanicOnPrmValue("NetMapSource", prm.NetMapSource)
} }
o := defaultMngOpts() o := defaultMngOpts()

View file

@ -1,4 +1,4 @@
package local package common
import ( import (
"context" "context"
@ -41,6 +41,6 @@ func (*OnlyKeyRemoteServerInfo) Address() string {
const invalidPrmValFmt = "invalid parameter %s (%T):%v" const invalidPrmValFmt = "invalid parameter %s (%T):%v"
func panicOnPrmValue(n string, v interface{}) { func PanicOnPrmValue(n string, v interface{}) {
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v)) panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
} }

View file

@ -5,6 +5,7 @@ import (
apiClient "github.com/nspcc-dev/neofs-api-go/pkg/client" apiClient "github.com/nspcc-dev/neofs-api-go/pkg/client"
reputationapi "github.com/nspcc-dev/neofs-api-go/pkg/reputation" reputationapi "github.com/nspcc-dev/neofs-api-go/pkg/reputation"
reputationutil "github.com/nspcc-dev/neofs-node/cmd/neofs-node/reputation/common"
"github.com/nspcc-dev/neofs-node/pkg/network" "github.com/nspcc-dev/neofs-node/pkg/network"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation" "github.com/nspcc-dev/neofs-node/pkg/services/reputation"
reputationcommon "github.com/nspcc-dev/neofs-node/pkg/services/reputation/common" reputationcommon "github.com/nspcc-dev/neofs-node/pkg/services/reputation/common"
@ -41,13 +42,13 @@ type RemoteProviderPrm struct {
func NewRemoteTrustProvider(prm RemoteProviderPrm) reputationrouter.RemoteWriterProvider { func NewRemoteTrustProvider(prm RemoteProviderPrm) reputationrouter.RemoteWriterProvider {
switch { switch {
case prm.LocalAddrSrc == nil: case prm.LocalAddrSrc == nil:
panicOnPrmValue("LocalAddrSrc", prm.LocalAddrSrc) reputationutil.PanicOnPrmValue("LocalAddrSrc", prm.LocalAddrSrc)
case prm.DeadEndProvider == nil: case prm.DeadEndProvider == nil:
panicOnPrmValue("DeadEndProvider", prm.DeadEndProvider) reputationutil.PanicOnPrmValue("DeadEndProvider", prm.DeadEndProvider)
case prm.Key == nil: case prm.Key == nil:
panicOnPrmValue("Key", prm.Key) reputationutil.PanicOnPrmValue("Key", prm.Key)
case prm.ClientCache == nil: case prm.ClientCache == nil:
panicOnPrmValue("ClientCache", prm.ClientCache) reputationutil.PanicOnPrmValue("ClientCache", prm.ClientCache)
} }
return &remoteTrustProvider{ return &remoteTrustProvider{
@ -67,7 +68,7 @@ func (rtp *remoteTrustProvider) InitRemote(srv reputationrouter.ServerInfo) (rep
if rtp.localAddrSrc.LocalAddress().String() == srv.Address() { if rtp.localAddrSrc.LocalAddress().String() == srv.Address() {
// if local => return no-op writer // if local => return no-op writer
return trustcontroller.SimpleWriterProvider(new(NopReputationWriter)), nil return trustcontroller.SimpleWriterProvider(new(reputationutil.NopReputationWriter)), nil
} }
ipAddr, err := network.IPAddrFromMultiaddr(addr) ipAddr, err := network.IPAddrFromMultiaddr(addr)

View file

@ -5,6 +5,7 @@ import (
"io" "io"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation" "github.com/nspcc-dev/neofs-node/pkg/services/reputation"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation/common/router"
) )
// Context wraps stdlib context // Context wraps stdlib context
@ -53,3 +54,11 @@ type WriterProvider interface {
// contexts, so specific ones may document their own behavior. // contexts, so specific ones may document their own behavior.
InitWriter(Context) (Writer, error) InitWriter(Context) (Writer, error)
} }
// ManagerBuilder defines an interface for providing a list
// of Managers for specific epoch. Implementation depends on trust value.
type ManagerBuilder interface {
// BuildManagers must compose list of managers. It depends on
// particular epoch and PeerID of the current route point.
BuildManagers(epoch uint64, p reputation.PeerID) ([]router.ServerInfo, error)
}

View file

@ -1,6 +1,10 @@
package managers package routes
import "fmt" import (
"fmt"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation/common"
)
// Prm groups the required parameters of the Builder's constructor. // Prm groups the required parameters of the Builder's constructor.
// //
@ -11,7 +15,7 @@ type Prm struct {
// Manager builder for current node. // Manager builder for current node.
// //
// Must not be nil. // Must not be nil.
ManagerBuilder ManagerBuilder ManagerBuilder common.ManagerBuilder
} }
// Builder represents component that routes node to its managers. // Builder represents component that routes node to its managers.
@ -21,7 +25,7 @@ type Prm struct {
// and optional components. After successful creation, // and optional components. After successful creation,
// the Builder is immediately ready to work through API. // the Builder is immediately ready to work through API.
type Builder struct { type Builder struct {
managerBuilder ManagerBuilder managerBuilder common.ManagerBuilder
} }
const invalidPrmValFmt = "invalid parameter %s (%T):%v" const invalidPrmValFmt = "invalid parameter %s (%T):%v"

View file

@ -0,0 +1,23 @@
package routes
import (
"github.com/nspcc-dev/neofs-node/pkg/services/reputation"
reputationroute "github.com/nspcc-dev/neofs-node/pkg/services/reputation/common/router"
"github.com/pkg/errors"
)
// NextStage builds Manager list for trusted node and returns it directly.
//
// If passed route has more than one point, then endpoint of the route is reached.
func (b *Builder) NextStage(epoch uint64, t reputation.Trust, passed []reputationroute.ServerInfo) ([]reputationroute.ServerInfo, error) {
if len(passed) > 1 {
return nil, nil
}
route, err := b.managerBuilder.BuildManagers(epoch, t.Peer())
if err != nil {
return nil, errors.Wrapf(err, "could not build managers for epoch: %d", epoch)
}
return route, nil
}

View file

@ -1,14 +0,0 @@
package managers
import (
"github.com/nspcc-dev/neofs-node/pkg/services/reputation"
reputationrouter "github.com/nspcc-dev/neofs-node/pkg/services/reputation/common/router"
)
// ManagerBuilder defines an interface for providing a list
// of Managers for specific epoch. Implementation depends on trust value.
type ManagerBuilder interface {
// BuildManagers must compose list of managers. It depends on
// particular epoch and PeerID of the current route point.
BuildManagers(epoch uint64, p reputation.PeerID) ([]reputationrouter.ServerInfo, error)
}

View file

@ -0,0 +1,52 @@
package routes
import (
"fmt"
"github.com/nspcc-dev/neofs-node/pkg/services/reputation/common"
)
// Prm groups the required parameters of the Builder's constructor.
//
// All values must comply with the requirements imposed on them.
// Passing incorrect parameter values will result in constructor
// failure (error or panic depending on the implementation).
type Prm struct {
// Manager builder for current node.
//
// Must not be nil.
ManagerBuilder common.ManagerBuilder
}
// Builder represents component that routes node to its managers.
//
// For correct operation, Builder must be created using
// the constructor (New) based on the required parameters
// and optional components. After successful creation,
// the Builder is immediately ready to work through API.
type Builder struct {
managerBuilder common.ManagerBuilder
}
const invalidPrmValFmt = "invalid parameter %s (%T):%v"
func panicOnPrmValue(n string, v interface{}) {
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
}
// New creates a new instance of the Builder.
//
// Panics if at least one value of the parameters is invalid.
//
// The created Builder does not require additional
// initialization and is completely ready for work.
func New(prm Prm) *Builder {
switch {
case prm.ManagerBuilder == nil:
panicOnPrmValue("ManagerBuilder", prm.ManagerBuilder)
}
return &Builder{
managerBuilder: prm.ManagerBuilder,
}
}

View file

@ -1,4 +1,4 @@
package managers package routes
import ( import (
"github.com/nspcc-dev/neofs-node/pkg/services/reputation" "github.com/nspcc-dev/neofs-node/pkg/services/reputation"
@ -6,7 +6,7 @@ import (
"github.com/pkg/errors" "github.com/pkg/errors"
) )
// NextStage builds Manager list for node and returns it directly. // NextStage builds Manager list for trusting node and returns it directly.
// //
// If passed route has more than one point, then endpoint of the route is reached. // If passed route has more than one point, then endpoint of the route is reached.
func (b *Builder) NextStage(epoch uint64, t reputation.Trust, passed []reputationroute.ServerInfo) ([]reputationroute.ServerInfo, error) { func (b *Builder) NextStage(epoch uint64, t reputation.Trust, passed []reputationroute.ServerInfo) ([]reputationroute.ServerInfo, error) {