From efb3b270385a62ce1eb440896c6ed50a43807aff Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Mon, 27 Sep 2021 15:50:07 +0100 Subject: [PATCH] pass options to transport constructors --- config/reflection_magic.go | 15 ++++++++++++--- config/transport.go | 4 ++-- config/transport_test.go | 20 +++++++++++++++++--- options.go | 4 ++-- 4 files changed, 33 insertions(+), 10 deletions(-) diff --git a/config/reflection_magic.go b/config/reflection_magic.go index 57e486ebc..2aee81dc3 100644 --- a/config/reflection_magic.go +++ b/config/reflection_magic.go @@ -1,6 +1,7 @@ package config import ( + "errors" "fmt" "reflect" "runtime" @@ -102,6 +103,7 @@ func makeConstructor( tpt interface{}, tptType reflect.Type, argTypes map[reflect.Type]constructor, + opts ...interface{}, ) (func(host.Host, *tptu.Upgrader, connmgr.ConnectionGater) (interface{}, error), error) { v := reflect.ValueOf(tpt) // avoid panicing on nil/zero value. @@ -123,17 +125,24 @@ func makeConstructor( } return func(h host.Host, u *tptu.Upgrader, cg connmgr.ConnectionGater) (interface{}, error) { - arguments := make([]reflect.Value, len(argConstructors)) + arguments := make([]reflect.Value, 0, len(argConstructors)+len(opts)) for i, makeArg := range argConstructors { if arg := makeArg(h, u, cg); arg != nil { - arguments[i] = reflect.ValueOf(arg) + arguments = append(arguments, reflect.ValueOf(arg)) } else { // ValueOf an un-typed nil yields a zero reflect // value. However, we _want_ the zero value of // the _type_. - arguments[i] = reflect.Zero(t.In(i)) + arguments = append(arguments, reflect.Zero(t.In(i))) } } + for _, opt := range opts { + // don't panic on nil options + if opt == nil { + return nil, errors.New("expected a transport option, got nil") + } + arguments = append(arguments, reflect.ValueOf(opt)) + } return callConstructor(v, arguments) }, nil } diff --git a/config/transport.go b/config/transport.go index 9f55838db..7b6b3d6fd 100644 --- a/config/transport.go +++ b/config/transport.go @@ -36,14 +36,14 @@ var transportArgTypes = argTypes // // And returns a type implementing transport.Transport and, optionally, an error // (as the second argument). -func TransportConstructor(tpt interface{}) (TptC, error) { +func TransportConstructor(tpt interface{}, opts ...interface{}) (TptC, error) { // Already constructed? if t, ok := tpt.(transport.Transport); ok { return func(_ host.Host, _ *tptu.Upgrader, _ connmgr.ConnectionGater) (transport.Transport, error) { return t, nil }, nil } - ctor, err := makeConstructor(tpt, transportType, transportArgTypes) + ctor, err := makeConstructor(tpt, transportType, transportArgTypes, opts...) if err != nil { return nil, err } diff --git a/config/transport_test.go b/config/transport_test.go index 753d91a30..d86e031a0 100644 --- a/config/transport_test.go +++ b/config/transport_test.go @@ -5,11 +5,25 @@ import ( "github.com/libp2p/go-libp2p-core/peer" "github.com/libp2p/go-libp2p-core/transport" + tptu "github.com/libp2p/go-libp2p-transport-upgrader" + "github.com/libp2p/go-tcp-transport" + + "github.com/stretchr/testify/require" ) func TestTransportVariadicOptions(t *testing.T) { _, err := TransportConstructor(func(_ peer.ID, _ ...int) transport.Transport { return nil }) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) +} + +func TestConstructorWithOpts(t *testing.T) { + var options []int + c, err := TransportConstructor(func(_ *tptu.Upgrader, opts ...int) transport.Transport { + options = opts + return tcp.NewTCPTransport(nil) + }, 42, 1337) + require.NoError(t, err) + _, err = c(nil, nil, nil) + require.NoError(t, err) + require.Equal(t, options, []int{42, 1337}) } diff --git a/options.go b/options.go index 9ded4dba4..3d20c975c 100644 --- a/options.go +++ b/options.go @@ -125,8 +125,8 @@ func Muxer(name string, tpt interface{}) Option { // * Public Key // * Address filter (filter.Filter) // * Peerstore -func Transport(tpt interface{}) Option { - tptc, err := config.TransportConstructor(tpt) +func Transport(tpt interface{}, opts ...interface{}) Option { + tptc, err := config.TransportConstructor(tpt, opts...) err = traceError(err, 1) return func(cfg *Config) error { if err != nil {