Router Network API updates regarding tcp/listen. (#643)

Author: cmaglie

cmd/arduino-router/network-api/network-api.go

@@ -22,8 +22,9 @@ func Register(router *msgpackrouter.Router) {
 	_ = router.RegisterMethod("tcp/connect", tcpConnect)
 
 	_ = router.RegisterMethod("tcp/listen", tcpListen)
-	_ = router.RegisterMethod("tcp/accept", tcpAccept)
+	_ = router.RegisterMethod("tcp/closeListener", tcpCloseListener)
 
+	_ = router.RegisterMethod("tcp/accept", tcpAccept)
 	_ = router.RegisterMethod("tcp/read", tcpRead)
 	_ = router.RegisterMethod("tcp/write", tcpWrite)
 	_ = router.RegisterMethod("tcp/close", tcpClose)
@@ -83,13 +84,19 @@ func tcpConnect(ctx context.Context, rpc *msgpackrpc.Connection, params []any) (
 }
 
 func tcpListen(ctx context.Context, rpc *msgpackrpc.Connection, params []any) (_result any, _err any) {
-	if len(params) != 1 {
-		return nil, []any{1, "Invalid number of parameters, expected listen address"}
+	if len(params) != 2 {
+		return nil, []any{1, "Invalid number of parameters, expected listen address and port"}
 	}
 	listenAddr, ok := params[0].(string)
 	if !ok {
 		return nil, []any{1, "Invalid parameter type, expected string for listen address"}
 	}
+	listenPort, ok := msgpackrpc.ToUint(params[1])
+	if !ok {
+		return nil, []any{1, "Invalid parameter type, expected uint16 for listen port"}
+	}
+
+	listenAddr = net.JoinHostPort(listenAddr, strconv.FormatUint(uint64(listenPort), 10))
 
 	listener, err := net.Listen("tcp", listenAddr)
 	if err != nil {
@@ -143,33 +150,50 @@ func tcpClose(ctx context.Context, rpc *msgpackrpc.Connection, params []any) (_r
 
 	lock.Lock()
 	conn, existsConn := liveConnections[id]
-	listener, existsListener := liveListeners[id]
 	if existsConn {
 		delete(liveConnections, id)
 	}
-	if existsListener {
-		delete(liveListeners, id)
-	}
 	lock.Unlock()
 
-	if !existsConn && !existsListener {
+	if !existsConn {
 		return nil, []any{2, fmt.Sprintf("Connection not found for ID: %d", id)}
 	}
 
-	// Close the connection or listener if it exists
-	// We do not return an error if the close operation fails, as it is not critical,
+	// Close the connection if it exists
+	// We do not return an error to the caller if the close operation fails, as it is not critical,
 	// but we only log the error for debugging purposes.
-	if existsConn {
-		if err := conn.Close(); err != nil {
-			return err.Error(), nil
-		}
+	if err := conn.Close(); err != nil {
+		return err.Error(), nil
 	}
+	return "", nil
+}
+
+func tcpCloseListener(ctx context.Context, rpc *msgpackrpc.Connection, params []any) (_result any, _err any) {
+	if len(params) != 1 {
+		return nil, []any{1, "Invalid number of parameters, expected listener ID"}
+	}
+	id, ok := msgpackrpc.ToUint(params[0])
+	if !ok {
+		return nil, []any{1, "Invalid parameter type, expected int for listener ID"}
+	}
+
+	lock.Lock()
+	listener, existsListener := liveListeners[id]
 	if existsListener {
-		if err := listener.Close(); err != nil {
-			return err.Error(), nil
-		}
+		delete(liveListeners, id)
+	}
+	lock.Unlock()
+
+	if !existsListener {
+		return nil, []any{2, fmt.Sprintf("Listener not found for ID: %d", id)}
 	}
 
+	// Close the listener if it exists
+	// We do not return an error to the caller if the close operation fails, as it is not critical,
+	// but we only log the error for debugging purposes.
+	if err := listener.Close(); err != nil {
+		return err.Error(), nil
+	}
 	return "", nil
 }
 

cmd/arduino-router/network-api/network-api_test.go

@@ -1,6 +1,7 @@
 package networkapi
 
 import (
+	"fmt"
 	"sync"
 	"testing"
 
@@ -143,16 +144,14 @@ const testCert = "-----BEGIN CERTIFICATE-----\n" +
 func TestNetworkAPI(t *testing.T) {
 	ctx := t.Context()
 	var rpc *msgpackrpc.Connection
-	listID, err := tcpListen(ctx, rpc, []any{"localhost:9999"})
+	listID, err := tcpListen(ctx, rpc, []any{"localhost", 9999})
 	require.Nil(t, err)
 	require.Equal(t, uint(1), listID)
 
 	var wg sync.WaitGroup
-	wg.Add(1)
-	go func() {
+	wg.Go(func() {
 		connID, err := tcpConnect(ctx, rpc, []any{"localhost", uint16(9999)})
 		require.Nil(t, err)
-		require.Equal(t, uint(2), connID)
 
 		n, err := tcpWrite(ctx, rpc, []any{connID, []byte("Hello")})
 		require.Nil(t, err)
@@ -163,17 +162,12 @@ func TestNetworkAPI(t *testing.T) {
 		require.Equal(t, "", res)
 
 		res, err = tcpClose(ctx, rpc, []any{connID})
-		require.Equal(t, []any{2, "Connection not found for ID: 2"}, err)
+		require.Equal(t, []any{2, fmt.Sprintf("Connection not found for ID: %d", connID)}, err)
 		require.Nil(t, res)
-
-		wg.Done()
-	}()
-
-	wg.Wait()
+	})
 
 	connID, err := tcpAccept(ctx, rpc, []any{listID})
 	require.Nil(t, err)
-	require.Equal(t, uint(3), connID)
 
 	buff, err := tcpRead(ctx, rpc, []any{connID, 3})
 	require.Nil(t, err)
@@ -187,16 +181,28 @@ func TestNetworkAPI(t *testing.T) {
 	require.Equal(t, []any{3, "Failed to read from connection: EOF"}, err)
 	require.Nil(t, buff)
 
-	res, err := tcpClose(ctx, rpc, []any{connID})
+	res, err := tcpCloseListener(ctx, rpc, []any{connID})
+	require.Equal(t, []any{2, fmt.Sprintf("Listener not found for ID: %d", connID)}, err)
+	require.Nil(t, res)
+
+	res, err = tcpClose(ctx, rpc, []any{connID})
 	require.Nil(t, err)
 	require.Equal(t, "", res)
 
 	res, err = tcpClose(ctx, rpc, []any{listID})
+	require.Equal(t, []any{2, fmt.Sprintf("Connection not found for ID: %d", listID)}, err)
+	require.Nil(t, res)
+
+	res, err = tcpCloseListener(ctx, rpc, []any{listID})
 	require.Nil(t, err)
 	require.Equal(t, "", res)
 
 	res, err = tcpClose(ctx, rpc, []any{listID})
-	require.Equal(t, []any{2, "Connection not found for ID: 1"}, err)
+	require.Equal(t, []any{2, fmt.Sprintf("Connection not found for ID: %d", listID)}, err)
+	require.Nil(t, res)
+
+	res, err = tcpCloseListener(ctx, rpc, []any{listID})
+	require.Equal(t, []any{2, fmt.Sprintf("Listener not found for ID: %d", listID)}, err)
 	require.Nil(t, res)
 
 	// Test SSL connection
@@ -212,4 +218,6 @@ func TestNetworkAPI(t *testing.T) {
 	connIDSSL, err = tcpConnectSSL(ctx, rpc, []any{"www.arduino.cc", uint16(443), testCert})
 	require.Equal(t, []any{2, "Failed to connect to server: tls: failed to verify certificate: x509: certificate signed by unknown authority"}, err)
 	require.Nil(t, connIDSSL)
+
+	wg.Wait()
 }