starpc 0.25.5 → 0.26.0

package/dist/echo/client-test.js

@@ -54,14 +54,14 @@ export async function runAbortControllerTest(client) {
     });
     await testRpc(async (signal) => {
         const stream = demoServiceClient.EchoServerStream({ body: 'test' }, signal);
-        let gotMsgs = 0;
+        const msgs = [];
         try {
             for await (const msg of stream) {
-                gotMsgs++;
+                msgs.push(msg);
             }
         }
         catch (err) {
-            if (gotMsgs < 3) {
+            if (msgs.length < 3) {
                 throw new Error('expected at least three messages before error');
             }
             throw err;

package/dist/srpc/channel.js

@@ -7,6 +7,7 @@ import { ERR_STREAM_IDLE } from './errors.js';
 // This implementation sends a "closed" message when close() is called.
 // However: if the remote is removed w/o closing cleanly, the stream will be left open!
 // Enable keepAliveMs and idleTimeoutMs to mitigate this issue with keep-alive messages.
+// NOTE: Browsers will throttle setTimeout in background tabs.
 export class ChannelStream {
     // isAcked checks if the stream is acknowledged by the remote.
     get isAcked() {

package/dist/srpc/watchdog.js

@@ -1,4 +1,5 @@
 // Watchdog must be fed every timeoutDuration or it will call the expired callback.
+// NOTE: Browsers will throttle setTimeout in background tabs.
 export class Watchdog {
     /**
      * Constructs a Watchdog instance.

package/echo/client-test.ts

@@ -63,13 +63,13 @@ export async function runAbortControllerTest(client: Client) {
 
   await testRpc(async (signal) => {
     const stream = demoServiceClient.EchoServerStream({ body: 'test' }, signal)
-    let gotMsgs = 0
+    const msgs = []
     try {
       for await (const msg of stream) {
-        gotMsgs++
+        msgs.push(msg)
       }
     } catch (err) {
-      if (gotMsgs < 3) {
+      if (msgs.length < 3) {
         throw new Error('expected at least three messages before error')
       }
       throw err

package/go.mod

@@ -9,7 +9,7 @@ require (
 )
 
 require (
-	github.com/aperturerobotics/util v1.13.5 // latest
+	github.com/aperturerobotics/util v1.13.6 // latest
 	github.com/libp2p/go-libp2p v0.32.2 // latest
 	github.com/libp2p/go-yamux/v4 v4.0.2-0.20240206065824-7222fbc3459d // master
 	github.com/sirupsen/logrus v1.9.3 // latest

package/go.sum

@@ -4,6 +4,8 @@ github.com/aperturerobotics/util v1.13.3 h1:N4JXKYql0R/A2hMuV79SZ2vaftf8tiN8DUJ8
 github.com/aperturerobotics/util v1.13.3/go.mod h1:JdziNd9tR6lWqc9bSMIe1At8Gagrg986rmtZuPCv6+w=
 github.com/aperturerobotics/util v1.13.5 h1:g8Q9VKBUYR5Nu5Ee/ZygVbe0JkGXeNq1fBkT0ipLBMY=
 github.com/aperturerobotics/util v1.13.5/go.mod h1:8AfpGb9RJqUItLBb5ec3sprpl9swYyHlgOw0HzkE+S8=
+github.com/aperturerobotics/util v1.13.6 h1:8FKBjj+vs23QZBiwkGod5WUY19Cisda48Rbg1zaqzZU=
+github.com/aperturerobotics/util v1.13.6/go.mod h1:8AfpGb9RJqUItLBb5ec3sprpl9swYyHlgOw0HzkE+S8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starpc",
-  "version": "0.25.5",
+  "version": "0.26.0",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {
@@ -67,7 +67,7 @@
     "esbuild": "^0.20.0",
     "prettier": "^3.2.4",
     "rimraf": "^5.0.1",
-    "ts-poet": "6.6.0",
+    "ts-poet": "6.7.0",
     "ts-proto": "^1.166.1",
     "typescript": "^5.3.2",
     "utf-8-validate": "^6.0.3"

package/srpc/channel.ts

@@ -43,6 +43,7 @@ export interface ChannelStreamOpts {
 // This implementation sends a "closed" message when close() is called.
 // However: if the remote is removed w/o closing cleanly, the stream will be left open!
 // Enable keepAliveMs and idleTimeoutMs to mitigate this issue with keep-alive messages.
+// NOTE: Browsers will throttle setTimeout in background tabs.
 export class ChannelStream<T = Uint8Array>
   implements Duplex<AsyncGenerator<T>, Source<T>, Promise<void>>
 {

package/srpc/client-prefix.go

@@ -57,7 +57,7 @@ func (i *PrefixClient) stripCheckServiceIDPrefix(service string) (string, error)
 // NewRawStream opens a new raw stream with the remote.
 // Implements OpenStreamFunc.
 // msgHandler must not be called concurrently.
-func (i *PrefixClient) NewRawStream(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (Writer, error) {
+func (i *PrefixClient) NewRawStream(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (PacketWriter, error) {
 	return i.client.NewRawStream(ctx, msgHandler, closeHandler)
 }
 

package/srpc/client-rpc.go

@@ -25,7 +25,7 @@ func NewClientRPC(ctx context.Context, service, method string) *ClientRPC {
 
 // Start sets the writer and writes the MsgSend message.
 // must only be called once!
-func (r *ClientRPC) Start(writer Writer, writeFirstMsg bool, firstMsg []byte) error {
+func (r *ClientRPC) Start(writer PacketWriter, writeFirstMsg bool, firstMsg []byte) error {
 	select {
 	case <-r.ctx.Done():
 		r.ctxCancel()

package/srpc/client-set.go

@@ -48,7 +48,7 @@ func (c *ClientSet) NewRawStream(
 	ctx context.Context,
 	msgHandler PacketDataHandler,
 	closeHandler CloseHandler,
-) (Writer, error) {
+) (PacketWriter, error) {
 	for _, client := range c.clients {
 		if client == nil {
 			continue

package/srpc/client-verbose.go

@@ -65,7 +65,7 @@ func (c *VClient) NewStream(ctx context.Context, service, method string, firstMs
 // NewRawStream opens a new raw stream with the remote.
 // Implements OpenStreamFunc.
 // msgHandler must not be called concurrently.
-func (c *VClient) NewRawStream(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (writer Writer, err error) {
+func (c *VClient) NewRawStream(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (writer PacketWriter, err error) {
 	t1 := time.Now()
 
 	defer func() {

package/srpc/client.go

@@ -18,7 +18,7 @@ type Client interface {
 	// NewRawStream opens a new raw stream with the remote.
 	// Implements OpenStreamFunc.
 	// msgHandler must not be called concurrently.
-	NewRawStream(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (Writer, error)
+	NewRawStream(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (PacketWriter, error)
 }
 
 // OpenStreamFunc opens a stream with a remote.
@@ -27,7 +27,7 @@ type OpenStreamFunc = func(
 	ctx context.Context,
 	msgHandler PacketDataHandler,
 	closeHandler CloseHandler,
-) (Writer, error)
+) (PacketWriter, error)
 
 // client implements Client with a transport.
 type client struct {
@@ -102,7 +102,7 @@ func (c *client) NewRawStream(
 	ctx context.Context,
 	msgHandler PacketDataHandler,
 	closeHandler CloseHandler,
-) (Writer, error) {
+) (PacketWriter, error) {
 	return c.openStream(ctx, msgHandler, closeHandler)
 }
 

package/srpc/common-rpc.go

@@ -24,7 +24,7 @@ type commonRPC struct {
 	// bcast broadcasts when below fields change
 	bcast broadcast.Broadcast
 	// writer is the writer to write messages to
-	writer Writer
+	writer PacketWriter
 	// dataQueue contains incoming data packets.
 	// note: packets may be len() == 0
 	dataQueue [][]byte

package/srpc/muxed-conn.go

@@ -72,7 +72,7 @@ func NewClientWithMuxedConn(conn network.MuxedConn) Client {
 
 // NewOpenStreamWithMuxedConn constructs a OpenStream func with a MuxedConn.
 func NewOpenStreamWithMuxedConn(conn network.MuxedConn) OpenStreamFunc {
-	return func(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (Writer, error) {
+	return func(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (PacketWriter, error) {
 		mstrm, err := conn.OpenStream(ctx)
 		if err != nil {
 			return nil, err

package/srpc/packet-rw.go

@@ -146,4 +146,4 @@ func (r *PacketReadWriter) readLengthPrefix(b []byte) uint32 {
 }
 
 // _ is a type assertion
-var _ Writer = (*PacketReadWriter)(nil)
+var _ PacketWriter = (*PacketReadWriter)(nil)

package/srpc/packet.go

@@ -1,6 +1,7 @@
 package srpc
 
-import "context"
+// CloseHandler handles the stream closing with an optional error.
+type CloseHandler = func(closeErr error)
 
 // PacketHandler handles a packet.
 //
@@ -11,12 +12,6 @@ type PacketHandler = func(pkt *Packet) error
 // PacketDataHandler handles a packet before it is parsed.
 type PacketDataHandler = func(data []byte) error
 
-// CloseHandler handles the stream closing with an optional error.
-type CloseHandler = func(closeErr error)
-
-// RawStreamCtor is a function that builds a raw stream.
-type RawStreamCtor func(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (Writer, error)
-
 // NewPacketDataHandler wraps a PacketHandler with a decoding step.
 func NewPacketDataHandler(handler PacketHandler) PacketDataHandler {
 	return func(data []byte) error {

package/srpc/server-pipe.go

@@ -9,7 +9,7 @@ import (
 // Stream with the given Server. Starts read pumps for both. Starts the
 // HandleStream function on the server in a separate goroutine.
 func NewServerPipe(server *Server) OpenStreamFunc {
-	return func(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (Writer, error) {
+	return func(ctx context.Context, msgHandler PacketDataHandler, closeHandler CloseHandler) (PacketWriter, error) {
 		srvPipe, clientPipe := net.Pipe()
 		go server.HandleStream(ctx, srvPipe)
 		clientPrw := NewPacketReadWriter(clientPipe)

package/srpc/server-rpc.go

@@ -15,7 +15,7 @@ type ServerRPC struct {
 
 // NewServerRPC constructs a new ServerRPC session.
 // note: call SetWriter before handling any incoming messages.
-func NewServerRPC(ctx context.Context, invoker Invoker, writer Writer) *ServerRPC {
+func NewServerRPC(ctx context.Context, invoker Invoker, writer PacketWriter) *ServerRPC {
 	rpc := &ServerRPC{invoker: invoker}
 	initCommonRPC(ctx, &rpc.commonRPC)
 	rpc.writer = writer

package/srpc/watchdog.ts

@@ -1,4 +1,5 @@
 // Watchdog must be fed every timeoutDuration or it will call the expired callback.
+// NOTE: Browsers will throttle setTimeout in background tabs.
 export class Watchdog {
   private timeoutDuration: number
   private expiredCallback: () => void

package/srpc/writer.go

@@ -1,9 +1,7 @@
 package srpc
 
-// Writer is the interface used to write messages to the remote.
-type Writer interface {
-	// Write writes raw data to the remote.
-	Write(p []byte) (n int, err error)
+// PacketWriter is the interface used to write messages to a PacketStream.
+type PacketWriter interface {
 	// WritePacket writes a packet to the remote.
 	WritePacket(p *Packet) error
 	// Close closes the writer.

package/srpc/raw-stream-rwc.go

@@ -1,161 +0,0 @@
-package srpc
-
-import (
-	"context"
-	"io"
-	"sync"
-
-	"github.com/aperturerobotics/util/broadcast"
-)
-
-// RawStreamRwc implements io.ReadWriteCloser with a raw stream.
-type RawStreamRwc struct {
-	// writer is used to write messages to the remote.
-	writer Writer
-	// mtx guards below fields
-	mtx sync.Mutex
-	// bcast is broadcasted when data is added to readQueue
-	bcast broadcast.Broadcast
-	// readQueue holds incoming data to read
-	readQueue [][]byte
-	// closed indicates whether the stream is closed
-	closed bool
-	// closeErr stores the error, if any, when closing the stream
-	closeErr error
-}
-
-func NewRawStreamRwc(ctx context.Context, ctorFn RawStreamCtor) (*RawStreamRwc, error) {
-	rwc := &RawStreamRwc{}
-	var err error
-	rwc.writer, err = ctorFn(ctx, rwc.handlePacketData, rwc.handleClose)
-	if err != nil {
-		return nil, err
-	}
-	return rwc, nil
-}
-
-// handlePacketData implements PacketDataHandler.
-func (r *RawStreamRwc) handlePacketData(pkt []byte) error {
-	r.mtx.Lock()
-	defer r.mtx.Unlock()
-
-	if r.closed {
-		return io.ErrClosedPipe
-	}
-
-	r.readQueue = append(r.readQueue, pkt)
-	r.bcast.Broadcast()
-	return nil
-}
-
-// handleClose handles the stream closing with an optional error.
-func (r *RawStreamRwc) handleClose(closeErr error) {
-	r.mtx.Lock()
-	defer r.mtx.Unlock()
-	if r.closed {
-		return
-	}
-	r.closed = true
-	r.closeErr = closeErr
-	r.bcast.Broadcast()
-}
-
-// Read reads data from the stream to p.
-// Implements io.Reader.
-func (r *RawStreamRwc) Read(p []byte) (n int, err error) {
-	readBuf := p
-	for len(readBuf) != 0 && err == nil {
-		// if the buffer has data, read from it.
-		var rn int
-		var read []byte
-
-		r.mtx.Lock()
-		if len(r.readQueue) != 0 {
-			nrq := r.readQueue[0]
-			// rn = amount of data to read
-			// minimum of len(readBuf) (length of space remaining in p) and len(nrq) (size of next pkt in read queue)
-			rn = min(len(readBuf), len(nrq))
-			// read the contents of nrq up to rn bytes
-			read = nrq[:rn]
-			// get the remainder of the packet that we won't read this time
-			nrq = nrq[rn:]
-			// if there is no more to read drop the pkt from the queue
-			if len(nrq) == 0 {
-				r.readQueue[0] = nil
-				r.readQueue = r.readQueue[1:]
-			} else {
-				// otherwise update the queued packet to be just the remainder
-				r.readQueue[0] = nrq
-			}
-		}
-
-		// check if the stream is closed
-		closed, closedErr := r.closed, r.closeErr
-		var wait <-chan struct{}
-
-		// if we didn't read anything and !closed, wait till something changes.
-		if rn == 0 && !closed {
-			wait = r.bcast.GetWaitCh()
-		}
-		r.mtx.Unlock()
-
-		// if we read data, copy it to the output buf
-		if rn != 0 {
-			// copy data to output buf
-			copy(readBuf, read)
-			n += rn
-			// advance readBuf by rn
-			readBuf = readBuf[rn:]
-			continue
-		}
-
-		// if we read data to p already, return now.
-		if n != 0 {
-			break
-		}
-
-		// if closed or error, return.
-		if closed {
-			if closedErr != nil {
-				return n, closedErr
-			}
-			return n, io.EOF
-		}
-
-		// wait for data or closed
-		<-wait
-	}
-
-	return n, err
-}
-
-// Write writes data to the stream.
-func (r *RawStreamRwc) Write(p []byte) (int, error) {
-	return r.writer.Write(p)
-}
-
-// WritePacket writes a packet to the remote.
-func (r *RawStreamRwc) WritePacket(p *Packet) error {
-	return r.writer.WritePacket(p)
-}
-
-// Close closes the stream.
-func (r *RawStreamRwc) Close() error {
-	r.mtx.Lock()
-	defer r.mtx.Unlock()
-
-	if r.closed {
-		return r.closeErr
-	}
-
-	r.closed = true
-	r.closeErr = r.writer.Close()
-	r.bcast.Broadcast()
-	return r.closeErr
-}
-
-// _ is a type assertion
-var (
-	_ io.ReadWriteCloser = ((*RawStreamRwc)(nil))
-	_ Writer             = ((*RawStreamRwc)(nil))
-)