starpc 0.50.0 → 0.52.0

package/echo/echo_srpc.pb.ts

@@ -11,6 +11,7 @@ import {
   buildEncodeMessageTransform,
   MessageStream,
   ProtoRpc,
+  ServerContext,
 } from 'starpc'
 
 /**
@@ -151,6 +152,79 @@ export interface Echoer {
   DoNothing(request: Empty, abortSignal?: AbortSignal): Promise<Empty>
 }
 
+/**
+ * Echoer service returns the given message.
+ *
+ * @generated from service echo.Echoer
+ */
+export interface EchoerHandler {
+  /**
+   * Echo returns the given message.
+   *
+   * @generated from rpc echo.Echoer.Echo
+   */
+  Echo(
+    request: EchoMsg,
+    abortSignal: AbortSignal,
+    context: ServerContext,
+  ): Promise<EchoMsg>
+
+  /**
+   * EchoServerStream is an example of a server -> client one-way stream.
+   *
+   * @generated from rpc echo.Echoer.EchoServerStream
+   */
+  EchoServerStream(
+    request: EchoMsg,
+    abortSignal: AbortSignal,
+    context: ServerContext,
+  ): MessageStream<EchoMsg>
+
+  /**
+   * EchoClientStream is an example of client->server one-way stream.
+   *
+   * @generated from rpc echo.Echoer.EchoClientStream
+   */
+  EchoClientStream(
+    request: MessageStream<EchoMsg>,
+    abortSignal: AbortSignal,
+    context: ServerContext,
+  ): Promise<EchoMsg>
+
+  /**
+   * EchoBidiStream is an example of a two-way stream.
+   *
+   * @generated from rpc echo.Echoer.EchoBidiStream
+   */
+  EchoBidiStream(
+    request: MessageStream<EchoMsg>,
+    abortSignal: AbortSignal,
+    context: ServerContext,
+  ): MessageStream<EchoMsg>
+
+  /**
+   * RpcStream opens a nested rpc call stream.
+   *
+   * @generated from rpc echo.Echoer.RpcStream
+   */
+  RpcStream(
+    request: MessageStream<RpcStreamPacket>,
+    abortSignal: AbortSignal,
+    context: ServerContext,
+  ): MessageStream<RpcStreamPacket>
+
+  /**
+   * DoNothing does nothing.
+   *
+   * @generated from rpc echo.Echoer.DoNothing
+   */
+  DoNothing(
+    request: Empty,
+    abortSignal: AbortSignal,
+    context: ServerContext,
+  ): Promise<Empty>
+}
+
 export const EchoerServiceName = EchoerDefinition.typeName
 
 export class EchoerClient implements Echoer {

package/echo/server.go

@@ -94,4 +94,4 @@ func (s *EchoServer) DoNothing(ctx context.Context, empty *emptypb.Empty) (*empt
 }
 
 // _ is a type assertion
-var _ SRPCEchoerServer = ((*EchoServer)(nil))
+var _ SRPCEchoerServer = (*EchoServer)(nil)

package/echo/server.ts

@@ -3,14 +3,15 @@ import { Message } from '@aptre/protobuf-es-lite'
 import { Empty } from '@aptre/protobuf-es-lite/google/protobuf/empty'
 import { EchoMsg } from './echo.pb.js'
 import { Server } from '../srpc/server.js'
+import type { ServerContext } from '../srpc/server-context.js'
 import { messagePushable, writeToPushable } from '../srpc/pushable.js'
 import { RpcStreamPacket } from '../rpcstream/rpcstream.pb.js'
 import { MessageStream } from '../srpc/message.js'
 import { handleRpcStream, RpcStreamHandler } from '../rpcstream/rpcstream.js'
-import { Echoer } from './echo_srpc.pb.js'
+import type { EchoerHandler } from './echo_srpc.pb.js'
 
 // EchoServer implements the Echoer server.
-export class EchoerServer implements Echoer {
+export class EchoerServer implements EchoerHandler {
   // proxyServer is the server used for RpcStream requests.
   private proxyServer?: Server
 
@@ -18,11 +19,19 @@ export class EchoerServer implements Echoer {
     this.proxyServer = proxyServer
   }
 
-  public async Echo(request: EchoMsg): Promise<Message<EchoMsg>> {
+  public async Echo(
+    request: EchoMsg,
+    _abortSignal: AbortSignal,
+    _context: ServerContext,
+  ): Promise<Message<EchoMsg>> {
     return request
   }
 
-  public async *EchoServerStream(request: EchoMsg): MessageStream<EchoMsg> {
+  public async *EchoServerStream(
+    request: EchoMsg,
+    _abortSignal: AbortSignal,
+    _context: ServerContext,
+  ): MessageStream<EchoMsg> {
     for (let i = 0; i < 5; i++) {
       yield request
       await new Promise((resolve) => setTimeout(resolve, 200))
@@ -31,6 +40,8 @@ export class EchoerServer implements Echoer {
 
   public async EchoClientStream(
     request: MessageStream<EchoMsg>,
+    _abortSignal: AbortSignal,
+    _context: ServerContext,
   ): Promise<Message<EchoMsg>> {
     // return the first message sent by the client.
     const message = await first(request)
@@ -42,6 +53,8 @@ export class EchoerServer implements Echoer {
 
   public EchoBidiStream(
     request: MessageStream<EchoMsg>,
+    _abortSignal: AbortSignal,
+    _context: ServerContext,
   ): MessageStream<EchoMsg> {
     // build result observable
     const result = messagePushable<EchoMsg>()
@@ -52,6 +65,8 @@ export class EchoerServer implements Echoer {
 
   public RpcStream(
     request: MessageStream<RpcStreamPacket>,
+    _abortSignal: AbortSignal,
+    _context: ServerContext,
   ): MessageStream<RpcStreamPacket> {
     return handleRpcStream(
       request[Symbol.asyncIterator](),
@@ -64,7 +79,11 @@ export class EchoerServer implements Echoer {
     )
   }
 
-  public async DoNothing(): Promise<Empty> {
+  public async DoNothing(
+    _request: Empty,
+    _abortSignal: AbortSignal,
+    _context: ServerContext,
+  ): Promise<Empty> {
     return {}
   }
 }

package/go.mod

@@ -3,7 +3,7 @@ module github.com/aperturerobotics/starpc
 go 1.25.0
 
 require (
-	github.com/aperturerobotics/common v0.34.4 // latest
+	github.com/aperturerobotics/common v0.35.0 // latest
 	github.com/aperturerobotics/protobuf-go-lite v0.16.0 // latest
 	github.com/aperturerobotics/util v1.34.9 // latest
 )

package/go.sum

@@ -4,6 +4,8 @@ github.com/aperturerobotics/cli v1.1.0 h1:7a+YRC+EY3npAnTzhHV5gLCiw91KS0Ts3XwLIL
 github.com/aperturerobotics/cli v1.1.0/go.mod h1:M7BFP9wow5ytTzMyJQOOO991fGfsUqdTI7gGEsHfTQ8=
 github.com/aperturerobotics/common v0.34.4 h1:RQTOm6LxEnucXkED/kruhKKAOL6tbaPzMgfHPKaES4k=
 github.com/aperturerobotics/common v0.34.4/go.mod h1:xnb1VBRs3x2o1PaKg0OlP7SqDaC9Hmrmt9xH85rOS+A=
+github.com/aperturerobotics/common v0.35.0 h1:VU4OPMXJyqT37lTOtNEMa3QLW5tR8YIBAKbjgxSzuZs=
+github.com/aperturerobotics/common v0.35.0/go.mod h1:xnb1VBRs3x2o1PaKg0OlP7SqDaC9Hmrmt9xH85rOS+A=
 github.com/aperturerobotics/go-protoc-gen-prost v0.0.0-20260705010911-9f53feac967b h1:MMk+AbWPCMfqc2Lm2bJl8lCCsuvlM2+C0CP10fpE3bc=
 github.com/aperturerobotics/go-protoc-gen-prost v0.0.0-20260705010911-9f53feac967b/go.mod h1:OBb/beWmr/pDIZAUfi86j/4tBh2v5ctTxKMqSnh9c/4=
 github.com/aperturerobotics/go-protoc-wasi v0.0.0-20260712054757-d8078c296c17 h1:WT1YmZjJf8fUF1zKbeNNKXFA+t8Wtbr8AVMAmdKcrUU=

package/integration/cross-language/go-client/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"io"
 	"net"
@@ -15,32 +14,13 @@ import (
 const bodyTxt = "hello world via starpc cross-language e2e test"
 
 func main() {
-	receiptMode := len(os.Args) > 1 && os.Args[1] == "receipt"
-	receiptCase := ""
-	addrIndex := 1
-	if receiptMode {
-		if len(os.Args) < 3 {
-			fmt.Fprintf(os.Stderr, "usage: go-client receipt <case> <addr>\n")
-			os.Exit(1)
-		}
-		receiptCase = os.Args[2]
-		addrIndex = 3
-		switch receiptCase {
-		case "commit", "abort", "loss", "bare-close":
-		default:
-			fmt.Fprintf(os.Stderr, "unknown receipt case: %s\n", receiptCase)
-			os.Exit(1)
-		}
-	}
-	if len(os.Args) <= addrIndex {
-		fmt.Fprintf(os.Stderr, "usage: go-client [receipt <case>] <addr>\n")
+	if len(os.Args) <= 1 {
+		fmt.Fprintf(os.Stderr, "usage: go-client <addr>\n")
 		os.Exit(1)
 	}
-	addr := os.Args[addrIndex]
-	var conn net.Conn
+	addr := os.Args[1]
 	openStream := func(ctx context.Context, msgHandler srpc.PacketDataHandler, closeHandler srpc.CloseHandler) (srpc.PacketWriter, error) {
-		var err error
-		conn, err = net.Dial("tcp", addr) //nolint:gosec
+		conn, err := net.Dial("tcp", addr) //nolint:gosec
 		if err != nil {
 			return nil, err
 		}
@@ -52,35 +32,22 @@ func main() {
 	client := srpc.NewClient(openStream)
 	echoClient := echo.NewSRPCEchoerClient(client)
 	ctx := context.Background()
-	if receiptMode {
-		if err := testReceipt(ctx, client, &conn, receiptCase); err != nil {
-			fmt.Fprintf(os.Stderr, "receipt test failed: %v\n", err)
-			os.Exit(1)
-		}
-		fmt.Println("All tests passed.")
-		return
-	}
-
 	if err := testUnary(ctx, echoClient); err != nil {
 		fmt.Fprintf(os.Stderr, "unary test failed: %v\n", err)
 		os.Exit(1)
 	}
-
 	if err := testServerStream(ctx, echoClient); err != nil {
 		fmt.Fprintf(os.Stderr, "server stream test failed: %v\n", err)
 		os.Exit(1)
 	}
-
 	if err := testClientStream(ctx, echoClient); err != nil {
 		fmt.Fprintf(os.Stderr, "client stream test failed: %v\n", err)
 		os.Exit(1)
 	}
-
 	if err := testBidiStream(ctx, echoClient); err != nil {
 		fmt.Fprintf(os.Stderr, "bidi stream test failed: %v\n", err)
 		os.Exit(1)
 	}
-
 	fmt.Println("All tests passed.")
 }
 
@@ -97,79 +64,6 @@ func testUnary(ctx context.Context, client echo.SRPCEchoerClient) error {
 	return nil
 }
 
-func testReceipt(
-	ctx context.Context,
-	client srpc.Client,
-	conn *net.Conn,
-	receiptCase string,
-) error {
-	fmt.Printf("Testing held unary receipt (%s)...\n", receiptCase)
-	out := new(echo.EchoMsg)
-	receipt, err := srpc.ExecCallReceipt(
-		ctx, client, echo.SRPCEchoerServiceID, "Echo",
-		&echo.EchoMsg{Body: bodyTxt}, out,
-	)
-	if err != nil {
-		return fmt.Errorf("receipt call: %w", err)
-	}
-	if out.GetBody() != bodyTxt {
-		return fmt.Errorf("expected %q got %q", bodyTxt, out.GetBody())
-	}
-
-	switch receiptCase {
-	case "commit":
-		if err := receipt.Commit(); err != nil {
-			return fmt.Errorf("receipt commit: %w", err)
-		}
-	case "abort":
-		if err := receipt.Abort(); err != nil {
-			return fmt.Errorf("receipt abort: %w", err)
-		}
-	case "loss":
-		if *conn == nil {
-			return errors.New("receipt connection is nil")
-		}
-		tcpConn, ok := (*conn).(*net.TCPConn)
-		if !ok {
-			return errors.New("receipt connection is not TCP")
-		}
-		if err := tcpConn.SetLinger(0); err != nil {
-			return fmt.Errorf("set receipt loss linger: %w", err)
-		}
-		if err := tcpConn.Close(); err != nil {
-			return fmt.Errorf("close lost connection: %w", err)
-		}
-		if err := receipt.Commit(); err == nil {
-			return errors.New("loss receipt commit unexpectedly succeeded")
-		}
-	case "bare-close":
-		if *conn == nil {
-			return errors.New("receipt connection is nil")
-		}
-		tcpConn, ok := (*conn).(*net.TCPConn)
-		if !ok {
-			return errors.New("receipt connection is not TCP")
-		}
-		if err := tcpConn.CloseWrite(); err != nil {
-			return fmt.Errorf("close receipt write side: %w", err)
-		}
-		if err := receipt.Commit(); err == nil {
-			return errors.New("bare-close receipt commit unexpectedly succeeded")
-		}
-	default:
-		return fmt.Errorf("unknown receipt case: %s", receiptCase)
-	}
-
-	if err := emitReceiptEvent(
-		fmt.Sprintf("CLIENT_RECEIPT_RESOLVED %s", receiptTerminalName(receiptCase)),
-	); err != nil {
-		return fmt.Errorf("record receipt resolution: %w", err)
-	}
-
-	fmt.Println("  PASSED")
-	return nil
-}
-
 func testServerStream(ctx context.Context, client echo.SRPCEchoerClient) error {
 	fmt.Println("Testing ServerStream RPC...")
 	strm, err := client.EchoServerStream(ctx, &echo.EchoMsg{Body: bodyTxt})
@@ -249,35 +143,3 @@ func testBidiStream(ctx context.Context, client echo.SRPCEchoerClient) error {
 	fmt.Println("  PASSED")
 	return nil
 }
-
-func receiptTerminalName(receiptCase string) string {
-	switch receiptCase {
-	case "commit":
-		return "committed"
-	case "abort":
-		return "canceled"
-	case "loss":
-		return "transportLost"
-	case "bare-close":
-		return "closed"
-	default:
-		return "unknown"
-	}
-}
-
-func emitReceiptEvent(line string) error {
-	fmt.Println(line)
-	fifo := os.Getenv("RECEIPT_EVENT_FIFO")
-	if fifo == "" {
-		return nil
-	}
-	file, err := os.OpenFile(fifo, os.O_WRONLY, 0) //nolint:gosec // FIFO path is created by the local integration runner.
-	if err != nil {
-		return err
-	}
-	if _, err := file.WriteString(line + "\n"); err != nil {
-		_ = file.Close()
-		return err
-	}
-	return file.Close()
-}

package/integration/cross-language/go-server/main.go

@@ -2,13 +2,10 @@ package main
 
 import (
 	"context"
-	"encoding/binary"
 	"fmt"
 	"net"
 	"os"
 	"os/signal"
-	"sync"
-	"sync/atomic"
 
 	"github.com/aperturerobotics/starpc/echo"
 	"github.com/aperturerobotics/starpc/srpc"
@@ -18,74 +15,13 @@ func main() {
 	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
 	defer cancel()
 
-	receiptMode := len(os.Args) > 1 && os.Args[1] == "receipt"
-	receiptCase := ""
-	if receiptMode {
-		if len(os.Args) < 3 {
-			fmt.Fprintln(os.Stderr, "usage: go-server receipt <case>")
-			os.Exit(1)
-		}
-		receiptCase = os.Args[2]
-		switch receiptCase {
-		case "commit", "abort", "loss", "bare-close":
-		default:
-			fmt.Fprintf(os.Stderr, "unknown receipt case: %s\n", receiptCase)
-			os.Exit(1)
-		}
-	}
 	mux := srpc.NewMux()
 	echoServer := echo.NewEchoServer(mux)
 	if err := echo.SRPCRegisterEchoer(mux, echoServer); err != nil {
 		fmt.Fprintf(os.Stderr, "register error: %v\n", err)
 		os.Exit(1)
 	}
-	var receiptDone <-chan struct{}
-	var finishReceipt func()
-	var receiptCommitted atomic.Bool
-	if receiptMode {
-		done := make(chan struct{})
-		var doneOnce sync.Once
-		receiptDone = done
-		finishReceipt = func() {
-			doneOnce.Do(func() {
-				close(done)
-			})
-		}
-	}
-	var invoker srpc.Invoker = mux
-	if receiptMode {
-		invoker = srpc.InvokerFunc(func(
-			serviceID, methodID string,
-			strm srpc.Stream,
-		) (bool, error) {
-			handled, err := mux.InvokeMethod(serviceID, methodID, strm)
-			if err != nil || !handled {
-				return handled, err
-			}
-			invocation, ok := srpc.GetServerInvocation(strm.Context())
-			if !ok {
-				return true, context.Canceled
-			}
-			kind, waitErr := invocation.WaitTerminal(context.Background())
-			markerErr := emitReceiptEvent(
-				fmt.Sprintf("SERVER_RECEIPT_TERMINAL %s", terminalName(kind)),
-			)
-			if waitErr != nil {
-				return true, waitErr
-			}
-			if markerErr != nil {
-				return true, markerErr
-			}
-			if kind == srpc.TerminalKind_TERMINAL_KIND_COMMITTED {
-				receiptCommitted.Store(true)
-			}
-			if kind != srpc.TerminalKind_TERMINAL_KIND_COMMITTED {
-				finishReceipt()
-			}
-			return true, nil
-		})
-	}
-	server := srpc.NewServer(invoker)
+	server := srpc.NewServer(mux)
 	ln, err := net.Listen("tcp", "127.0.0.1:0")
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "listen error: %v\n", err)
@@ -93,120 +29,16 @@ func main() {
 	}
 	defer ln.Close()
 
-	if receiptMode {
-		go func() {
-			<-receiptDone
-			_ = ln.Close()
-		}()
-	}
-
 	fmt.Printf("LISTENING %s\n", ln.Addr().String())
-
 	go func() {
 		<-ctx.Done()
 		_ = ln.Close()
 	}()
-
 	for {
 		conn, err := ln.Accept()
 		if err != nil {
 			return
 		}
-		var stream net.Conn
-		stream = conn
-		if receiptMode {
-			stream = &receiptConn{
-				Conn:          conn,
-				finishReceipt: finishReceipt,
-				committed:     &receiptCommitted,
-			}
-		}
-		go server.HandleStream(ctx, stream)
-	}
-}
-
-type receiptConn struct {
-	net.Conn
-	finishReceipt func()
-	committed     *atomic.Bool
-	inspect       []byte
-	ackPending    bool
-}
-
-func (c *receiptConn) Write(p []byte) (int, error) {
-	if !c.ackPending {
-		if err := c.observeReceiptPackets(p); err != nil {
-			return 0, err
-		}
-	}
-	n, err := c.Conn.Write(p)
-	if err != nil {
-		return n, err
-	}
-	if c.ackPending && n == len(p) {
-		c.finishReceipt()
-		c.ackPending = false
-	}
-	return n, nil
-}
-
-func (c *receiptConn) observeReceiptPackets(p []byte) error {
-	c.inspect = append(c.inspect, p...)
-	for len(c.inspect) >= 4 {
-		size := int(binary.LittleEndian.Uint32(c.inspect[:4]))
-		if len(c.inspect) < 4+size {
-			break
-		}
-		pkt := &srpc.Packet{}
-		if err := pkt.UnmarshalVT(c.inspect[4 : 4+size]); err != nil {
-			return err
-		}
-		c.inspect = c.inspect[4+size:]
-		data := pkt.GetCallData()
-		if !c.committed.Load() {
-			continue
-		}
-		if data == nil || !data.GetComplete() || data.GetError() != "" {
-			continue
-		}
-		if err := emitReceiptEvent("SERVER_RECEIPT_ACK_WRITE committed"); err != nil {
-			return err
-		}
-		c.ackPending = true
-	}
-	return nil
-}
-
-func terminalName(kind srpc.TerminalKind) string {
-	switch kind {
-	case srpc.TerminalKind_TERMINAL_KIND_COMMITTED:
-		return "committed"
-	case srpc.TerminalKind_TERMINAL_KIND_CANCELED:
-		return "canceled"
-	case srpc.TerminalKind_TERMINAL_KIND_TRANSPORT_LOST:
-		return "transportLost"
-	case srpc.TerminalKind_TERMINAL_KIND_CLOSED:
-		return "closed"
-	case srpc.TerminalKind_TERMINAL_KIND_ABANDONED:
-		return "abandoned"
-	default:
-		return "unknown"
-	}
-}
-
-func emitReceiptEvent(line string) error {
-	fmt.Println(line)
-	fifo := os.Getenv("RECEIPT_EVENT_FIFO")
-	if fifo == "" {
-		return nil
-	}
-	file, err := os.OpenFile(fifo, os.O_WRONLY, 0) //nolint:gosec // FIFO path is created by the local integration runner.
-	if err != nil {
-		return err
-	}
-	if _, err := file.WriteString(line + "\n"); err != nil {
-		_ = file.Close()
-		return err
+		go server.HandleStream(ctx, conn)
 	}
-	return file.Close()
 }