starpc 0.3.5 → 0.3.6

package/dist/echo/echo.js

@@ -47,7 +47,6 @@ export const EchoMsg = {
     },
 };
 export class EchoerClientImpl {
-    rpc;
     constructor(rpc) {
         this.rpc = rpc;
         this.Echo = this.Echo.bind(this);

package/dist/srpc/broadcast-channel.js

@@ -2,14 +2,6 @@ import { EventIterator } from 'event-iterator';
 import { DuplexConn } from './conn-duplex.js';
 // BroadcastChannelIterable is a AsyncIterable wrapper for BroadcastChannel.
 export class BroadcastChannelIterable {
-    // readChannel is the incoming broadcast channel
-    readChannel;
-    // writeChannel is the outgoing broadcast channel
-    writeChannel;
-    // sink is the sink for incoming messages.
-    sink;
-    // source is the source for outgoing messages.
-    source;
     constructor(readChannel, writeChannel) {
         this.readChannel = readChannel;
         this.writeChannel = writeChannel;
@@ -52,8 +44,6 @@ export function newBroadcastChannelIterable(readName, writeName) {
 //
 // expects Uint8Array objects over the BroadcastChannel.
 export class BroadcastChannelConn extends DuplexConn {
-    // broadcastChannel is the broadcast channel iterable
-    broadcastChannel;
     constructor(readChannel, writeChannel, server, connParams) {
         const broadcastChannel = new BroadcastChannelIterable(readChannel, writeChannel);
         super(broadcastChannel, server, connParams);

package/dist/srpc/client.js

@@ -19,10 +19,6 @@ function writeClientStream(call, data) {
 }
 // Client implements the ts-proto Rpc interface with the drpcproto protocol.
 export class Client {
-    // openConnFn is a promise which contains the OpenStreamFunc.
-    openConnFn;
-    // _openConnFn resolves openConnFn.
-    _openConnFn;
     constructor(openConnFn) {
         this.openConnFn = this.setOpenConnFn(openConnFn);
     }
@@ -84,7 +80,7 @@ export class Client {
     }
     // serverStreamingRequest starts a server-side streaming request.
     serverStreamingRequest(service, method, data) {
-        const pushServerData = pushable();
+        const pushServerData = pushable({ objectMode: true });
         const serverData = observableFrom(pushServerData);
         this.startRpc(service, method, data)
             .then(async (call) => {
@@ -103,7 +99,7 @@ export class Client {
     }
     // bidirectionalStreamingRequest starts a two-way streaming request.
     bidirectionalStreamingRequest(service, method, data) {
-        const pushServerData = pushable();
+        const pushServerData = pushable({ objectMode: true });
         const serverData = observableFrom(pushServerData);
         this.startRpc(service, method, null)
             .then(async (call) => {

package/dist/srpc/common-rpc.js

@@ -2,20 +2,6 @@ import { pushable } from 'it-pushable';
 import { Packet } from './rpcproto.js';
 // CommonRPC is common logic between server and client RPCs.
 export class CommonRPC {
-    // sink is the data sink for incoming messages.
-    sink;
-    // source is the packet source for outgoing Packets.
-    source;
-    // _source is used to write to the source.
-    _source;
-    // rpcDataSource emits incoming client RPC messages to the caller.
-    rpcDataSource;
-    // _rpcDataSource is used to write to the rpc message source.
-    _rpcDataSource;
-    // service is the rpc service
-    service;
-    // method is the rpc method
-    method;
     constructor() {
         this.sink = this._createSink();
         const sourcev = this._createSource();

package/dist/srpc/conn-duplex.js

@@ -4,12 +4,10 @@ import { Conn } from './conn.js';
 //
 // expects Uint8Array objects
 export class DuplexConn extends Conn {
-    // channel is the iterable
-    channel;
     constructor(duplex, server, connParams) {
         super(server, connParams);
         this.channel = duplex;
-        pipe(this, this.channel, this);
+        pipe(this.channel, this, this.channel);
     }
     // getChannelDuplex returns the Duplex channel.
     getChannelDuplex() {

package/dist/srpc/conn.js

@@ -5,10 +5,6 @@ import { Client } from './client.js';
 // Implements the server by handling incoming streams.
 // If the server is unset, rejects any incoming streams.
 export class Conn {
-    // muxer is the mplex stream muxer.
-    muxer;
-    // server is the server side, if set.
-    server;
     constructor(server, connParams) {
         if (server) {
             this.server = server;

package/dist/srpc/handler.js

@@ -4,10 +4,6 @@ import { from as observableFrom } from 'rxjs';
 import { buildDecodeMessageTransform, buildEncodeMessageTransform, } from './message.js';
 // StaticHandler is a handler with a definition and implementation.
 export class StaticHandler {
-    // service is the service id
-    service;
-    // methods is the map of method to invoke fn
-    methods;
     constructor(serviceID, methods) {
         this.service = serviceID;
         this.methods = methods;
@@ -38,23 +34,27 @@ export function createInvokeFn(methodInfo, methodProto) {
             objectMode: true,
         });
         // pipe responseSink to dataSink.
-        const responsePipe = pipe(responseSink, buildEncodeMessageTransform(methodInfo.responseType), dataSink);
+        pipe(responseSink, buildEncodeMessageTransform(methodInfo.responseType), dataSink);
+        // requestSource is a Source of decoded request messages.
+        const requestSource = pipe(dataSource, requestDecode);
         // build the request argument.
         let requestArg;
         if (methodInfo.requestStream) {
-            // requestSource is a Source of decoded request messages.
-            const requestSource = pipe(dataSource, requestDecode);
             // convert the request data source into an Observable<T>
             requestArg = observableFrom(requestSource);
         }
         else {
             // receive a single message for the argument.
-            const requestRx = requestDecode(dataSource);
-            for await (const msg of requestRx) {
-                requestArg = msg;
-                break;
+            for await (const msg of requestSource) {
+                if (msg) {
+                    requestArg = msg;
+                    break;
+                }
             }
         }
+        if (!requestArg) {
+            throw new Error('request object was empty');
+        }
         // Call the implementation.
         try {
             const responseObj = methodProto(requestArg);
@@ -77,9 +77,7 @@ export function createInvokeFn(methodInfo, methodProto) {
                         },
                         complete: () => {
                             responseSink.end();
-                            responsePipe.finally(() => {
-                                resolve();
-                            });
+                            resolve();
                         },
                     });
                 });

package/dist/srpc/message-port.js

@@ -2,14 +2,6 @@ import { EventIterator } from 'event-iterator';
 import { DuplexConn } from './conn-duplex.js';
 // MessagePortIterable is a AsyncIterable wrapper for MessagePort.
 export class MessagePortIterable {
-    // port is the message port
-    port;
-    // sink is the sink for incoming messages.
-    sink;
-    // source is the source for outgoing messages.
-    source;
-    // _source is the EventIterator for source.
-    _source;
     constructor(port) {
         this.port = port;
         this.sink = this._createSink();
@@ -51,8 +43,6 @@ export function newMessagePortIterable(port) {
 //
 // expects Uint8Array objects over the MessagePort.
 export class MessagePortConn extends DuplexConn {
-    // messagePort is the message port iterable.
-    messagePort;
     constructor(port, server, connParams) {
         const messagePort = new MessagePortIterable(port);
         super(messagePort, server, connParams);

package/dist/srpc/mux.js

@@ -5,8 +5,10 @@ export function createMux() {
 // StaticMux contains a in-memory mapping between service ID and handlers.
 // implements Mux
 export class StaticMux {
-    // services contains a mapping from service id to handlers.
-    services = {};
+    constructor() {
+        // services contains a mapping from service id to handlers.
+        this.services = {};
+    }
     register(handler) {
         const serviceID = handler?.getServiceID();
         if (!serviceID) {

package/dist/srpc/server-rpc.js

@@ -1,8 +1,6 @@
 import { CommonRPC } from './common-rpc.js';
 // ServerRPC is an ongoing RPC from the server side.
 export class ServerRPC extends CommonRPC {
-    // mux is used to handle incoming rpcs.
-    mux;
     constructor(mux) {
         super();
         this.mux = mux;

package/dist/srpc/server.js

@@ -3,8 +3,6 @@ import { ServerRPC } from './server-rpc.js';
 import { parseLengthPrefixTransform, prependLengthPrefixTransform, decodePacketSource, encodePacketSource, } from './packet.js';
 // Server implements the SRPC server in TypeScript with a Mux.
 export class Server {
-    // mux is the mux used to handle requests.
-    mux;
     constructor(mux) {
         this.mux = mux;
     }

package/dist/srpc/websocket.js

@@ -4,15 +4,13 @@ import { Mplex } from '@libp2p/mplex';
 import { Conn } from './conn.js';
 // WebSocketConn implements a connection with a WebSocket and optional Server.
 export class WebSocketConn extends Conn {
-    // socket is the web socket
-    socket;
     constructor(socket, server) {
         super(server, {
             muxerFactory: new Mplex(),
         });
         this.socket = socket;
         const socketDuplex = duplex(socket);
-        pipe(this.source, socketDuplex, this.sink);
+        pipe(socketDuplex, this, socketDuplex);
     }
     // getSocket returns the websocket.
     getSocket() {

package/e2e/e2e_test.go

@@ -3,10 +3,13 @@ package e2e
 import (
 	"context"
 	"io"
+	"net"
 	"testing"
 
 	"github.com/aperturerobotics/starpc/echo"
 	"github.com/aperturerobotics/starpc/srpc"
+	"github.com/libp2p/go-libp2p/p2p/muxer/mplex"
+	mp "github.com/libp2p/go-mplex"
 	"github.com/pkg/errors"
 )
 
@@ -20,9 +23,24 @@ func RunE2E(t *testing.T, cb func(client echo.SRPCEchoerClient) error) {
 	}
 	server := srpc.NewServer(mux)
 
+	// note: also possible to do without mplex:
+	// openStream := srpc.NewServerPipe(server)
+	// client := srpc.NewClient(openStream)
+
 	// construct the client
-	openStream := srpc.NewServerPipe(server)
-	client := srpc.NewClient(openStream)
+	clientPipe, serverPipe := net.Pipe()
+
+	ctx := context.Background()
+	go func() {
+		serverMp, _ := mp.NewMultiplex(serverPipe, false, nil)
+		_ = server.AcceptMuxedConn(ctx, mplex.NewMuxedConn(serverMp))
+	}()
+
+	clientMp, err := mp.NewMultiplex(clientPipe, true, nil)
+	if err != nil {
+		t.Fatal(err.Error())
+	}
+	client := srpc.NewClientWithMuxedConn(mplex.NewMuxedConn(clientMp))
 
 	// construct the client rpc interface
 	clientEcho := echo.NewSRPCEchoerClient(client)

package/go.mod

@@ -9,8 +9,9 @@ require (
 )
 
 require (
-	github.com/libp2p/go-libp2p v0.20.1
+	github.com/libp2p/go-libp2p v0.20.1-0.20220622205512-3cf611ad8c9c
 	github.com/libp2p/go-libp2p-core v0.16.1
+	github.com/libp2p/go-mplex v0.7.0
 	github.com/sirupsen/logrus v1.8.2-0.20220112234510-85981c045988
 )
 
@@ -25,7 +26,6 @@ require (
 	github.com/klauspost/compress v1.15.1 // indirect
 	github.com/klauspost/cpuid/v2 v2.0.12 // indirect
 	github.com/libp2p/go-buffer-pool v0.0.2 // indirect
-	github.com/libp2p/go-mplex v0.7.0 // indirect
 	github.com/libp2p/go-openssl v0.0.7 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
 	github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1 // indirect

package/go.sum

@@ -65,8 +65,8 @@ github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
 github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
 github.com/libp2p/go-buffer-pool v0.0.2 h1:QNK2iAFa8gjAe1SPz6mHSMuCcjs+X1wlHzeOSqcmlfs=
 github.com/libp2p/go-buffer-pool v0.0.2/go.mod h1:MvaB6xw5vOrDl8rYZGLFdKAuk/hRoRZd1Vi32+RXyFM=
-github.com/libp2p/go-libp2p v0.20.1 h1:tCgC8yXtleyOg/mp+ZoCcA+aryAhueCfFmAVXURT/PM=
-github.com/libp2p/go-libp2p v0.20.1/go.mod h1:XgJHsOhEBVBXp/2Sj9bm/yEyD94uunAaP6oaegdcKks=
+github.com/libp2p/go-libp2p v0.20.1-0.20220622205512-3cf611ad8c9c h1:BTR12zXVGQtdk9bT5GLOmdzJrhyFO6YUH3/e8lnkjQ0=
+github.com/libp2p/go-libp2p v0.20.1-0.20220622205512-3cf611ad8c9c/go.mod h1:tqyre7jPbLfhzjQfpiFX6x7wj/sqt1074riPM0Xn/qI=
 github.com/libp2p/go-libp2p-core v0.16.1 h1:bWoiEBqVkpJ13hbv/f69tHODp86t6mvc4fBN4DkK73M=
 github.com/libp2p/go-libp2p-core v0.16.1/go.mod h1:O3i/7y+LqUb0N+qhzXjBjjpchgptWAVMG1Voegk7b4c=
 github.com/libp2p/go-libp2p-testing v0.9.2 h1:dCpODRtRaDZKF8HXT9qqqgON+OMEB423Knrgeod8j84=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starpc",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {

package/srpc/client-rpc.go

@@ -46,9 +46,8 @@ func NewClientRPC(ctx context.Context, service, method string) *ClientRPC {
 }
 
 // Start sets the writer and writes the MsgSend message.
-// firstMsg can be nil, but is usually set if this is a non-streaming rpc.
 // must only be called once!
-func (r *ClientRPC) Start(writer Writer, firstMsg []byte) error {
+func (r *ClientRPC) Start(writer Writer, writeFirstMsg bool, firstMsg []byte) error {
 	select {
 	case <-r.ctx.Done():
 		r.Close()
@@ -56,7 +55,13 @@ func (r *ClientRPC) Start(writer Writer, firstMsg []byte) error {
 	default:
 	}
 	r.writer = writer
-	pkt := NewCallStartPacket(r.service, r.method, firstMsg)
+	var firstMsgEmpty bool
+	if writeFirstMsg {
+		firstMsgEmpty = len(firstMsg) == 0
+	} else {
+		firstMsg = nil
+	}
+	pkt := NewCallStartPacket(r.service, r.method, firstMsg, firstMsgEmpty)
 	if err := writer.WritePacket(pkt); err != nil {
 		r.Close()
 		return err

package/srpc/client.go

@@ -48,7 +48,7 @@ func (c *client) Invoke(rctx context.Context, service, method string, in, out Me
 	if err != nil {
 		return err
 	}
-	if err := clientRPC.Start(writer, firstMsg); err != nil {
+	if err := clientRPC.Start(writer, true, firstMsg); err != nil {
 		return err
 	}
 	msgs, err := clientRPC.ReadAll()
@@ -85,7 +85,7 @@ func (c *client) NewStream(ctx context.Context, service, method string, firstMsg
 	if err != nil {
 		return nil, err
 	}
-	if err := clientRPC.Start(writer, firstMsgData); err != nil {
+	if err := clientRPC.Start(writer, firstMsg != nil, firstMsgData); err != nil {
 		return nil, err
 	}
 

package/srpc/client.ts

@@ -109,7 +109,7 @@ export class Client implements TsProtoRpc {
     method: string,
     data: Uint8Array
   ): Observable<Uint8Array> {
-    const pushServerData: Pushable<Uint8Array> = pushable()
+    const pushServerData: Pushable<Uint8Array> = pushable({ objectMode: true })
     const serverData = observableFrom(pushServerData)
     this.startRpc(service, method, data)
       .then(async (call) => {
@@ -132,7 +132,7 @@ export class Client implements TsProtoRpc {
     method: string,
     data: Observable<Uint8Array>
   ): Observable<Uint8Array> {
-    const pushServerData: Pushable<Uint8Array> = pushable()
+    const pushServerData: Pushable<Uint8Array> = pushable({ objectMode: true })
     const serverData = observableFrom(pushServerData)
     this.startRpc(service, method, null)
       .then(async (call) => {

package/srpc/conn-duplex.ts

@@ -18,7 +18,7 @@ export class DuplexConn extends Conn {
   ) {
     super(server, connParams)
     this.channel = duplex
-    pipe(this, this.channel, this)
+    pipe(this.channel, this, this.channel)
   }
 
   // getChannelDuplex returns the Duplex channel.

package/srpc/handler.ts

@@ -84,28 +84,34 @@ export function createInvokeFn(
     })
 
     // pipe responseSink to dataSink.
-    const responsePipe = pipe(
+    pipe(
       responseSink,
       buildEncodeMessageTransform(methodInfo.responseType),
       dataSink
     )
 
+    // requestSource is a Source of decoded request messages.
+    const requestSource = pipe(dataSource, requestDecode)
+
     // build the request argument.
     let requestArg: any
     if (methodInfo.requestStream) {
-      // requestSource is a Source of decoded request messages.
-      const requestSource = pipe(dataSource, requestDecode)
       // convert the request data source into an Observable<T>
       requestArg = observableFrom(requestSource)
     } else {
       // receive a single message for the argument.
-      const requestRx = requestDecode(dataSource)
-      for await (const msg of requestRx) {
-        requestArg = msg
-        break
+      for await (const msg of requestSource) {
+        if (msg) {
+          requestArg = msg
+          break
+        }
       }
     }
 
+    if (!requestArg) {
+      throw new Error('request object was empty')
+    }
+
     // Call the implementation.
     try {
       const responseObj = methodProto(requestArg)
@@ -128,9 +134,7 @@ export function createInvokeFn(
             },
             complete: () => {
               responseSink.end()
-              responsePipe.finally(() => {
-                resolve()
-              })
+              resolve()
             },
           })
         })

package/srpc/muxed-conn.go

@@ -0,0 +1,31 @@
+package srpc
+
+import (
+	"context"
+
+	"github.com/libp2p/go-libp2p-core/network"
+)
+
+// NewClientWithMuxedConn constructs a new client with a MuxedConn.
+func NewClientWithMuxedConn(conn network.MuxedConn) Client {
+	openStreamFn := NewOpenStreamWithMuxedConn(conn)
+	return NewClient(openStreamFn)
+}
+
+// NewOpenStreamWithMuxedConn constructs a OpenStream func with a MuxedConn.
+func NewOpenStreamWithMuxedConn(conn network.MuxedConn) OpenStreamFunc {
+	return func(ctx context.Context, msgHandler func(pkt *Packet) error) (Writer, error) {
+		mstrm, err := conn.OpenStream(ctx)
+		if err != nil {
+			return nil, err
+		}
+		rw := NewPacketReadWriter(mstrm, msgHandler)
+		go func() {
+			err := rw.ReadPump()
+			if err != nil {
+				_ = rw.Close()
+			}
+		}()
+		return rw, nil
+	}
+}

package/srpc/packet.go

@@ -16,12 +16,13 @@ func (p *Packet) Validate() error {
 }
 
 // NewCallStartPacket constructs a new CallStart packet.
-func NewCallStartPacket(service, method string, data []byte) *Packet {
+func NewCallStartPacket(service, method string, data []byte, dataIsZero bool) *Packet {
 	return &Packet{Body: &Packet_CallStart{
 		CallStart: &CallStart{
 			RpcService: service,
 			RpcMethod:  method,
 			Data:       data,
+			DataIsZero: dataIsZero,
 		},
 	}}
 }
@@ -40,7 +41,7 @@ func (p *CallStart) Validate() error {
 }
 
 // NewCallDataPacket constructs a new CallData packet.
-func NewCallDataPacket(data []byte, complete bool, err error) *Packet {
+func NewCallDataPacket(data []byte, dataIsZero bool, complete bool, err error) *Packet {
 	var errStr string
 	if err != nil {
 		errStr = err.Error()
@@ -48,7 +49,7 @@ func NewCallDataPacket(data []byte, complete bool, err error) *Packet {
 	return &Packet{Body: &Packet_CallData{
 		CallData: &CallData{
 			Data:       data,
-			DataIsZero: len(data) == 0 && !complete && err == nil,
+			DataIsZero: dataIsZero,
 			Complete:   err != nil || complete,
 			Error:      errStr,
 		},

package/srpc/rpc-stream.go

@@ -42,7 +42,7 @@ func (r *RPCStream) MsgSend(msg Message) error {
 	if err != nil {
 		return err
 	}
-	outPkt := NewCallDataPacket(msgData, false, nil)
+	outPkt := NewCallDataPacket(msgData, len(msgData) == 0, false, nil)
 	return r.writer.WritePacket(outPkt)
 }
 
@@ -62,7 +62,7 @@ func (r *RPCStream) MsgRecv(msg Message) error {
 
 // CloseSend signals to the remote that we will no longer send any messages.
 func (r *RPCStream) CloseSend() error {
-	outPkt := NewCallDataPacket(nil, true, nil)
+	outPkt := NewCallDataPacket(nil, false, true, nil)
 	return r.writer.WritePacket(outPkt)
 }
 

package/srpc/server-rpc.go

@@ -138,7 +138,7 @@ func (r *ServerRPC) invokeRPC() {
 	if err == nil && !ok {
 		err = ErrUnimplemented
 	}
-	outPkt := NewCallDataPacket(nil, true, err)
+	outPkt := NewCallDataPacket(nil, false, true, err)
 	_ = r.writer.WritePacket(outPkt)
 	r.ctxCancel()
 	_ = r.writer.Close()
@@ -149,7 +149,7 @@ func (r *ServerRPC) invokeRPC() {
 func (r *ServerRPC) Close() {
 	r.ctxCancel()
 	if r.service == "" {
-		// invokeRPC has not been called
+		// invokeRPC has not been called, otherwise it would call Close()
 		_ = r.writer.Close()
 	}
 }

package/srpc/server.go

@@ -27,7 +27,9 @@ func (s *Server) HandleStream(ctx context.Context, rwc io.ReadWriteCloser) error
 	serverRPC := NewServerRPC(subCtx, s.mux)
 	prw := NewPacketReadWriter(rwc, serverRPC.HandlePacket)
 	serverRPC.SetWriter(prw)
-	return prw.ReadPump()
+	err := prw.ReadPump()
+	_ = rwc.Close()
+	return err
 }
 
 // AcceptMuxedConn runs a loop which calls Accept on a muxer to handle streams.

package/srpc/websocket.go

@@ -63,6 +63,3 @@ func (w *WebSocketConn) OpenStream(ctx context.Context, msgHandler func(pkt *Pac
 func (w *WebSocketConn) Close() error {
 	return w.conn.Close(websocket.StatusGoingAway, "conn closed")
 }
-
-// _ is a type assertion
-var _ Conn = ((*WebSocketConn)(nil))

package/srpc/websocket.ts

@@ -17,7 +17,7 @@ export class WebSocketConn extends Conn {
     })
     this.socket = socket
     const socketDuplex = duplex(socket)
-    pipe(this.source, socketDuplex, this.sink)
+    pipe(socketDuplex, this, socketDuplex)
   }
 
   // getSocket returns the websocket.

package/srpc/conn.go

@@ -1,7 +0,0 @@
-package srpc
-
-// Conn represents a connection to a remote.
-type Conn interface {
-	// GetOpenStreamFunc returns the OpenStream func.
-	GetOpenStreamFunc() OpenStreamFunc
-}