fix(api): multiaddr is now a slice, handle it in parsing as such

Author: janos

pkg/api/peer.go

@@ -24,30 +24,14 @@ func (s *Service) peerConnectHandler(w http.ResponseWriter, r *http.Request) {
 
 	mux.Vars(r)["multi-address"] = "/" + mux.Vars(r)["multi-address"]
 	paths := struct {
-		MultiAddress string `map:"multi-address" validate:"required"`
+		MultiAddress multiaddr.Multiaddr `map:"multi-address" validate:"required"`
 	}{}
 	if response := s.mapStructure(mux.Vars(r), &paths); response != nil {
 		response("invalid path params", logger, w)
 		return
 	}
 
-	mAddr, err := multiaddr.NewMultiaddr(paths.MultiAddress)
-	if err != nil {
-		logger.Debug("invalid multiaddress", "address", paths.MultiAddress, "error", err)
-		jsonhttp.BadRequest(w, jsonhttp.StatusResponse{
-			Code:    http.StatusBadRequest,
-			Message: "invalid path params",
-			Reasons: []jsonhttp.Reason{
-				{
-					Field: "multi-address",
-					Error: err.Error(),
-				},
-			},
-		})
-		return
-	}
-
-	bzzAddr, err := s.p2p.Connect(r.Context(), []multiaddr.Multiaddr{mAddr})
+	bzzAddr, err := s.p2p.Connect(r.Context(), []multiaddr.Multiaddr{paths.MultiAddress})
 
 	if err != nil {
 		logger.Debug("p2p connect failed", "addresses", paths.MultiAddress, "error", err)

pkg/api/peer_test.go

@@ -62,7 +62,6 @@ func TestConnect(t *testing.T) {
 	})
 
 	t.Run("ok", func(t *testing.T) {
-		t.Parallel()
 		jsonhttptest.Request(t, testServer, http.MethodPost, "/connect"+underlay, http.StatusOK,
 			jsonhttptest.WithExpectedJSONResponse(api.PeerConnectResponse{
 				Address: overlay.String(),
@@ -71,7 +70,6 @@ func TestConnect(t *testing.T) {
 	})
 
 	t.Run("error", func(t *testing.T) {
-		t.Parallel()
 		jsonhttptest.Request(t, testServer, http.MethodPost, "/connect"+errorUnderlay, http.StatusInternalServerError,
 			jsonhttptest.WithExpectedJSONResponse(jsonhttp.StatusResponse{
 				Code:    http.StatusInternalServerError,
@@ -81,7 +79,6 @@ func TestConnect(t *testing.T) {
 	})
 
 	t.Run("error - add peer", func(t *testing.T) {
-		t.Parallel()
 		testServer, _, _, _ := newTestServer(t, testServerOptions{
 			P2P: mock.New(mock.WithConnectFunc(func(ctx context.Context, addrs []ma.Multiaddr) (*bzz.Address, error) {
 				for _, addr := range addrs {

pkg/api/util.go

@@ -210,14 +210,23 @@ func mapStructure(input, output any, hooks map[string]func(v string) (string, er
 		case reflect.String:
 			field.SetString(value)
 		case reflect.Slice:
-			if value == "" {
-				return nil // Nil slice.
-			}
-			val, err := hex.DecodeString(value)
-			if err != nil {
-				return err
+			switch field.Type() {
+			case reflect.TypeFor[multiaddr.Multiaddr]():
+				val, err := multiaddr.NewMultiaddr(value)
+				if err != nil {
+					return err
+				}
+				field.Set(reflect.ValueOf(val))
+			default:
+				if value == "" {
+					return nil // Nil slice.
+				}
+				val, err := hex.DecodeString(value)
+				if err != nil {
+					return err
+				}
+				field.SetBytes(val)
 			}
-			field.SetBytes(val)
 		case reflect.Array:
 			switch field.Interface().(type) {
 			case common.Hash:
@@ -251,15 +260,6 @@ func mapStructure(input, output any, hooks map[string]func(v string) (string, er
 				}
 				field.Set(reflect.ValueOf(*val))
 			}
-		case reflect.Interface:
-			switch field.Type() {
-			case reflect.TypeFor[multiaddr.Multiaddr]():
-				val, err := multiaddr.NewMultiaddr(value)
-				if err != nil {
-					return err
-				}
-				field.Set(reflect.ValueOf(val))
-			}
 		default:
 			return fmt.Errorf("unsupported type %T", field.Interface())
 		}

pkg/api/util_test.go

@@ -17,6 +17,7 @@ import (
 	"github.com/ethersphere/bee/v2/pkg/api"
 	"github.com/ethersphere/bee/v2/pkg/swarm"
 	"github.com/google/go-cmp/cmp"
+	"github.com/multiformats/go-multiaddr"
 )
 
 type (
@@ -95,11 +96,20 @@ type (
 	mapSwarmAddressTest struct {
 		SwarmAddressVal swarm.Address `map:"swarmAddressVal"`
 	}
+
+	mapMultiaddrTest struct {
+		MultiaddrVal multiaddr.Multiaddr `map:"multiaddrVal"`
+	}
 )
 
 func TestMapStructure(t *testing.T) {
 	t.Parallel()
 
+	validMultiaddr, err := multiaddr.NewMultiaddr("/ip4/127.0.0.1/tcp/8080")
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	tests := []struct {
 		name    string
 		src     any
@@ -497,6 +507,10 @@ func TestMapStructure(t *testing.T) {
 		name: "swarm.Address value",
 		src:  map[string]string{"swarmAddressVal": "1234567890abcdef"},
 		want: &mapSwarmAddressTest{SwarmAddressVal: swarm.MustParseHexAddress("1234567890abcdef")},
+	}, {
+		name: "multiaddr.Multiaddr value",
+		src:  map[string]string{"multiaddrVal": "/ip4/127.0.0.1/tcp/8080"},
+		want: &mapMultiaddrTest{MultiaddrVal: validMultiaddr},
 	}}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {