Skip to content

Commit

Permalink
pass options to transport constructors
Browse files Browse the repository at this point in the history
  • Loading branch information
marten-seemann committed Sep 29, 2021
1 parent 79a2100 commit efb3b27
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 10 deletions.
15 changes: 12 additions & 3 deletions config/reflection_magic.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package config

import (
"errors"
"fmt"
"reflect"
"runtime"
Expand Down Expand Up @@ -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.
Expand All @@ -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
}
4 changes: 2 additions & 2 deletions config/transport.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
20 changes: 17 additions & 3 deletions config/transport_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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})
}
4 changes: 2 additions & 2 deletions options.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit efb3b27

Please sign in to comment.