starpc 0.0.1 → 0.1.0

package/srpc/packet-rw.go

@@ -0,0 +1,102 @@
+package srpc
+
+import (
+	"bytes"
+	"encoding/binary"
+	"io"
+
+	"github.com/pkg/errors"
+)
+
+// maxMessageSize is the max message size in bytes
+var maxMessageSize = 1e7
+
+// PacketReaderWriter reads and writes packets from a io.ReadWriter.
+// Uses a LittleEndian uint32 length prefix.
+type PacketReaderWriter struct {
+	// rw is the io.ReadWriterCloser
+	rw io.ReadWriteCloser
+	// cb is the callback
+	cb PacketHandler
+	// buf is the buffered data
+	buf bytes.Buffer
+}
+
+// NewPacketReadWriter constructs a new read/writer.
+func NewPacketReadWriter(rw io.ReadWriteCloser, cb PacketHandler) *PacketReaderWriter {
+	return &PacketReaderWriter{rw: rw, cb: cb}
+}
+
+// WritePacket writes a packet to the writer.
+func (r *PacketReaderWriter) WritePacket(p *Packet) error {
+	msgSize := p.SizeVT()
+	data := make([]byte, 4+msgSize)
+	binary.LittleEndian.PutUint32(data, uint32(msgSize))
+	_, err := p.MarshalToVT(data[4:])
+	if err != nil {
+		return err
+	}
+	_, err = r.rw.Write(data)
+	return err
+}
+
+// ReadPump executes the read pump in a goroutine.
+func (r *PacketReaderWriter) ReadPump() error {
+	var currLen uint32
+	buf := make([]byte, 2048)
+	for {
+		n, err := r.rw.Read(buf)
+		if err != nil {
+			if err == io.EOF {
+				err = nil
+			}
+			return err
+		}
+		_, err = r.buf.Write(buf[:n])
+		if err != nil {
+			return err
+		}
+
+		// check if we have enough for a length prefix
+		bufLen := r.buf.Len()
+		if currLen == 0 {
+			if bufLen < 4 {
+				continue
+			}
+			currLen = r.readLengthPrefix(r.buf.Bytes())
+			if currLen == 0 {
+				return errors.New("unexpected zero len prefix")
+			}
+			if currLen > uint32(maxMessageSize) {
+				return errors.Errorf("message size %v greater than maximum %v", currLen, maxMessageSize)
+			}
+		}
+		if currLen != 0 && bufLen >= int(currLen)+4 {
+			pkt := r.buf.Next(int(currLen + 4))[4:]
+			currLen = 0
+			npkt := &Packet{}
+			if err := npkt.UnmarshalVT(pkt); err != nil {
+				return err
+			}
+			if err := r.cb(npkt); err != nil {
+				return err
+			}
+		}
+	}
+}
+
+// Close closes the packet rw.
+func (r *PacketReaderWriter) Close() error {
+	return r.rw.Close()
+}
+
+// readLengthPrefix reads the length prefix.
+func (r *PacketReaderWriter) readLengthPrefix(b []byte) uint32 {
+	if len(b) < 4 {
+		return 0
+	}
+	return binary.LittleEndian.Uint32(b)
+}
+
+// _ is a type assertion
+var _ Writer = (*PacketReaderWriter)(nil)

package/srpc/packet.go

@@ -0,0 +1,71 @@
+package srpc
+
+// PacketHandler handles a packet.
+type PacketHandler = func(pkt *Packet) error
+
+// Validate performs cursory validation of the packet.
+func (p *Packet) Validate() error {
+	switch b := p.GetBody().(type) {
+	case *Packet_CallStart:
+		return b.CallStart.Validate()
+	case *Packet_CallData:
+		return b.CallData.Validate()
+	case *Packet_CallStartResp:
+		return b.CallStartResp.Validate()
+	default:
+		return ErrUnrecognizedPacket
+	}
+}
+
+// NewCallStartPacket constructs a new CallStart packet.
+func NewCallStartPacket(service, method string, data []byte) *Packet {
+	return &Packet{Body: &Packet_CallStart{
+		CallStart: &CallStart{
+			RpcService: service,
+			RpcMethod:  method,
+			Data:       data,
+		},
+	}}
+}
+
+// Validate performs cursory validation of the packet.
+func (p *CallStart) Validate() error {
+	method := p.GetRpcMethod()
+	if len(method) == 0 {
+		return ErrEmptyMethodID
+	}
+	service := p.GetRpcService()
+	if len(service) == 0 {
+		return ErrEmptyServiceID
+	}
+	return nil
+}
+
+// NewCallDataPacket constructs a new CallData packet.
+func NewCallDataPacket(data []byte, complete bool, err error) *Packet {
+	var errStr string
+	if err != nil {
+		errStr = err.Error()
+	}
+	return &Packet{Body: &Packet_CallData{
+		CallData: &CallData{
+			Data:     data,
+			Complete: err != nil || complete,
+			Error:    errStr,
+		},
+	}}
+}
+
+// Validate performs cursory validation of the packet.
+func (p *CallData) Validate() error {
+	if len(p.GetData()) == 0 && !p.GetComplete() && len(p.GetError()) == 0 {
+		return ErrEmptyPacket
+	}
+	return nil
+}
+
+// Validate performs cursory validation of the packet.
+func (p *CallStartResp) Validate() error {
+	// nothing to check, empty packet is valid.
+	return nil
+}

package/srpc/packet.ts

@@ -0,0 +1,105 @@
+import type { Source, Transform } from 'it-stream-types'
+import { Packet } from './rpcproto'
+import {
+  encode as lengthPrefixEncode,
+  decode as lengthPrefixDecode,
+} from 'it-length-prefixed'
+
+// decodePacketSource unmarshals and async yields encoded Packets.
+export async function* decodePacketSource(
+  source: Source<Uint8Array | Uint8Array[]>
+): AsyncIterable<Packet> {
+  for await (const pkt of source) {
+    if (Array.isArray(pkt)) {
+      for (const p of pkt) {
+        yield* [Packet.decode(p)]
+      }
+    } else {
+      yield* [Packet.decode(pkt)]
+    }
+  }
+}
+
+// encodePacketSource marshals and async yields packets.
+export async function* encodePacketSource(
+  source: Source<Packet | Packet[]>
+): AsyncIterable<Uint8Array> {
+  for await (const pkt of source) {
+    if (Array.isArray(pkt)) {
+      for (const p of pkt) {
+        yield* [Packet.encode(p).finish()]
+      }
+    } else {
+      yield* [Packet.encode(pkt).finish()]
+    }
+  }
+}
+
+// uint32LEDecode removes the length prefix.
+const uint32LEDecode = (data: Uint8Array) => {
+  if (data.length < 4) {
+    throw RangeError('Could not decode int32BE')
+  }
+
+  const view = new DataView(data.buffer, data.byteOffset, data.byteLength)
+  return view.getUint32(0, true)
+}
+uint32LEDecode.bytes = 4
+
+// uint32LEEncode adds the length prefix.
+const uint32LEEncode = (value: number, target?: Uint8Array, offset?: number) => {
+  target = target ?? new Uint8Array(4)
+  const view = new DataView(target.buffer, target.byteOffset, target.byteLength)
+  view.setUint32(offset ?? 0, value, true)
+  return target
+}
+uint32LEEncode.bytes = 4
+
+// prependLengthPrefixTransform adds a length prefix to a message source.
+// little-endian uint32
+export function prependLengthPrefixTransform(): Transform<Uint8Array> {
+  return lengthPrefixEncode({lengthEncoder: uint32LEEncode})
+}
+
+// parseLengthPrefixTransform parses the length prefix from a message source.
+// little-endian uint32
+export function parseLengthPrefixTransform(): Transform<Uint8Array> {
+  return lengthPrefixDecode({ lengthDecoder: uint32LEDecode })
+}
+
+// encodeUint32Le encodes the number as a uint32 with little endian.
+export function encodeUint32Le(value: number): Uint8Array {
+  // output is a 4 byte array
+  const output = new Uint8Array(4)
+  for (let index = 0; index < output.length; index++) {
+    const b = value & 0xff
+    output[index] = b
+    value = (value - b) / 256
+  }
+  return output
+}
+
+// decodeUint32Le decodes a uint32 from a 4 byte Uint8Array.
+// returns 0 if decoding failed.
+// callers should check that len(data) == 4
+export function decodeUint32Le(data: Uint8Array): number {
+  let value = 0
+  let nbytes = 4
+  if (data.length < nbytes) {
+    nbytes = data.length
+  }
+  for (let i = nbytes - 1; i >= 0; i--) {
+    value = value * 256 + data[i]
+  }
+  return value
+}
+
+// prependPacketLen adds the message length prefix to a packet.
+export function prependPacketLen(msgData: Uint8Array): Uint8Array {
+  const msgLen = msgData.length
+  const msgLenData = encodeUint32Le(msgLen)
+  const merged = new Uint8Array(msgLen + msgLenData.length)
+  merged.set(msgLenData)
+  merged.set(msgData, msgLenData.length)
+  return merged
+}

package/srpc/rpc-stream.go

@@ -0,0 +1,76 @@
+package srpc
+
+import (
+	"context"
+	"io"
+)
+
+// RPCStream implements the stream interface passed to implementations.
+type RPCStream struct {
+	// ctx is the stream context
+	ctx context.Context
+	// writer is the stream writer
+	writer Writer
+	// dataCh is the incoming data channel.
+	dataCh chan []byte
+}
+
+// NewRPCStream constructs a new Stream with a ClientRPC.
+// dataCh should be closed when no more messages will arrive.
+func NewRPCStream(ctx context.Context, writer Writer, dataCh chan []byte) *RPCStream {
+	return &RPCStream{
+		ctx:    ctx,
+		writer: writer,
+		dataCh: dataCh,
+	}
+}
+
+// Context is canceled when the Stream is no longer valid.
+func (r *RPCStream) Context() context.Context {
+	return r.ctx
+}
+
+// MsgSend sends the message to the remote.
+func (r *RPCStream) MsgSend(msg Message) error {
+	select {
+	case <-r.ctx.Done():
+		return context.Canceled
+	default:
+	}
+
+	msgData, err := msg.MarshalVT()
+	if err != nil {
+		return err
+	}
+	outPkt := NewCallDataPacket(msgData, false, nil)
+	return r.writer.WritePacket(outPkt)
+}
+
+// MsgRecv receives an incoming message from the remote.
+// Parses the message into the object at msg.
+func (r *RPCStream) MsgRecv(msg Message) error {
+	select {
+	case <-r.Context().Done():
+		return context.Canceled
+	case data, ok := <-r.dataCh:
+		if !ok {
+			return io.EOF
+		}
+		return msg.UnmarshalVT(data)
+	}
+}
+
+// CloseSend signals to the remote that we will no longer send any messages.
+func (r *RPCStream) CloseSend() error {
+	outPkt := NewCallDataPacket(nil, true, nil)
+	return r.writer.WritePacket(outPkt)
+}
+
+// Close closes the stream.
+func (r *RPCStream) Close() error {
+	_ = r.writer.Close()
+	return nil
+}
+
+// _ is a type assertion
+var _ Stream = ((*RPCStream)(nil))