starpc 0.22.5 → 0.22.7

package/go.mod

@@ -1,6 +1,6 @@
 module github.com/aperturerobotics/starpc
 
-go 1.20
+go 1.21
 
 require (
 	github.com/pkg/errors v0.9.1 // latest
@@ -9,7 +9,7 @@ require (
 )
 
 require (
-	github.com/aperturerobotics/util v1.11.0 // latest
+	github.com/aperturerobotics/util v1.12.0 // latest
 	github.com/libp2p/go-libp2p v0.32.2 // latest
 	github.com/libp2p/go-yamux/v4 v4.0.2-0.20231213140704-4c5812896512 // master
 	github.com/sirupsen/logrus v1.9.3 // latest

package/go.sum

@@ -1,5 +1,9 @@
 github.com/aperturerobotics/util v1.11.0 h1:SpbpNw23DACYkiZ9cCauP98Nwg73T04YkfD4E/WZ2Hc=
 github.com/aperturerobotics/util v1.11.0/go.mod h1:d84OAQAGXCpl7JOBstnal91Lm6nKgk+vBgtHPgxBYrQ=
+github.com/aperturerobotics/util v1.11.3 h1:qg7TTe1L/rtoENssNKwz+VMeA3CCDVQ5SnYWig6WMOk=
+github.com/aperturerobotics/util v1.11.3/go.mod h1:d84OAQAGXCpl7JOBstnal91Lm6nKgk+vBgtHPgxBYrQ=
+github.com/aperturerobotics/util v1.12.0 h1:jdEU/xbApQIuc4cq2/JRnJmA21243StGsODIU5vekik=
+github.com/aperturerobotics/util v1.12.0/go.mod h1:d84OAQAGXCpl7JOBstnal91Lm6nKgk+vBgtHPgxBYrQ=
 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.22.5",
+  "version": "0.22.7",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {
@@ -65,7 +65,7 @@
     "bufferutil": "^4.0.7",
     "depcheck": "^1.4.6",
     "esbuild": "^0.19.11",
-    "prettier": "^3.0.3",
+    "prettier": "^3.2.4",
     "rimraf": "^5.0.1",
     "ts-poet": "6.6.0",
     "ts-proto": "^1.166.1",
@@ -87,7 +87,7 @@
     "long": "^5.2.3",
     "memoize-one": "^6.0.0",
     "patch-package": "^8.0.0",
-    "protobufjs": "^7.2.5",
+    "protobufjs": "^7.2.6",
     "uint8arraylist": "^2.4.7",
     "ws": "^8.15.1"
   }

package/srpc/msg-stream.go

@@ -10,6 +10,7 @@ type MsgStreamRw interface {
 	//
 	// returns io.EOF if the stream ended.
 	ReadOne() ([]byte, error)
+
 	// WriteCallData writes a call data packet.
 	WriteCallData(data []byte, complete bool, err error) error
 }
@@ -45,16 +46,15 @@ func (r *MsgStream) Context() context.Context {
 
 // MsgSend sends the message to the remote.
 func (r *MsgStream) MsgSend(msg Message) error {
-	select {
-	case <-r.ctx.Done():
+	if err := r.ctx.Err(); err != nil {
 		return context.Canceled
-	default:
 	}
 
 	msgData, err := msg.MarshalVT()
 	if err != nil {
 		return err
 	}
+
 	return r.rw.WriteCallData(msgData, false, nil)
 }
 

package/srpc/packet-rw.go

@@ -44,10 +44,11 @@ func (r *PacketReadWriter) WritePacket(p *Packet) error {
 	msgSize := p.SizeVT()
 	data := make([]byte, 4+msgSize)
 	binary.LittleEndian.PutUint32(data, uint32(msgSize))
-	_, err := p.MarshalToVT(data[4:])
+	_, err := p.MarshalToSizedBufferVT(data[4:])
 	if err != nil {
 		return err
 	}
+
 	var written, n int
 	for written < len(data) {
 		n, err = r.rw.Write(data)
@@ -56,6 +57,7 @@ func (r *PacketReadWriter) WritePacket(p *Packet) error {
 		}
 		written += n
 	}
+
 	return nil
 }
 
@@ -76,6 +78,7 @@ func (r *PacketReadWriter) ReadToHandler(cb PacketDataHandler) error {
 	var currLen uint32
 	buf := make([]byte, 2048)
 	isOpen := true
+
 	for isOpen {
 		// read some data into the buffer
 		n, err := r.rw.Read(buf)
@@ -93,6 +96,8 @@ func (r *PacketReadWriter) ReadToHandler(cb PacketDataHandler) error {
 			return err
 		}
 
+	EmitIfEnough:
+
 		// check if we have enough data for a length prefix
 		bufLen := r.buf.Len()
 		if bufLen < 4 {
@@ -117,6 +122,9 @@ func (r *PacketReadWriter) ReadToHandler(cb PacketDataHandler) error {
 			if err := cb(pkt); err != nil {
 				return err
 			}
+
+			// check if there's still enough in the buffer
+			goto EmitIfEnough
 		}
 	}
 

package/srpc/raw-stream-rwc.go

@@ -72,21 +72,28 @@ func (r *RawStreamRwc) Read(p []byte) (n int, err error) {
 		r.mtx.Lock()
 		if len(r.readQueue) != 0 {
 			nrq := r.readQueue[0]
-			rn = len(readBuf)
-			if nrLen := len(nrq); nrLen < rn {
-				rn = nrLen
-			}
+			// 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()
 		}
@@ -94,9 +101,10 @@ func (r *RawStreamRwc) Read(p []byte) (n int, err error) {
 
 		// if we read data, copy it to the output buf
 		if rn != 0 {
-			// advance readBuf by rn
+			// copy data to output buf
 			copy(readBuf, read)
 			n += rn
+			// advance readBuf by rn
 			readBuf = readBuf[rn:]
 			continue
 		}

package/srpc/server.go

@@ -41,13 +41,12 @@ func (s *Server) HandleStream(ctx context.Context, rwc io.ReadWriteCloser) {
 // Returns context.Canceled or io.EOF when the loop is complete / closed.
 func (s *Server) AcceptMuxedConn(ctx context.Context, mc network.MuxedConn) error {
 	for {
-		select {
-		case <-ctx.Done():
+		if err := ctx.Err(); err != nil {
 			return context.Canceled
-		default:
-			if mc.IsClosed() {
-				return io.EOF
-			}
+		}
+
+		if mc.IsClosed() {
+			return io.EOF
 		}
 
 		muxedStream, err := mc.AcceptStream()