starpc 0.49.20 → 0.50.0

package/srpc/rpcproto.pb.ts

@@ -2,6 +2,7 @@
 // @generated from file github.com/aperturerobotics/starpc/srpc/rpcproto.proto (package srpc, syntax proto3)
 /* eslint-disable */
 
+import { createEnumType } from '@aptre/protobuf-es-lite/enum'
 import type { MessageType } from '@aptre/protobuf-es-lite/message'
 import { createMessageType } from '@aptre/protobuf-es-lite/message'
 import { ScalarType } from '@aptre/protobuf-es-lite/scalar'
@@ -9,6 +10,67 @@ import type { PartialFieldInfo } from '@aptre/protobuf-es-lite/field'
 
 export const protobufPackage = 'srpc'
 
+/**
+ * TerminalKind is the terminal state of a held unary invocation.
+ *
+ * @generated from enum srpc.TerminalKind
+ */
+export enum TerminalKind {
+  /**
+   * TERMINAL_KIND_UNSPECIFIED is not a valid terminal state.
+   *
+   * @generated from enum value: TERMINAL_KIND_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * TERMINAL_KIND_COMMITTED identifies an explicit remote CallData completion.
+   *
+   * @generated from enum value: TERMINAL_KIND_COMMITTED = 1;
+   */
+  COMMITTED = 1,
+
+  /**
+   * TERMINAL_KIND_CANCELED identifies a remote CallCancel packet.
+   *
+   * @generated from enum value: TERMINAL_KIND_CANCELED = 2;
+   */
+  CANCELED = 2,
+
+  /**
+   * TERMINAL_KIND_TRANSPORT_LOST identifies a remote error or transport failure.
+   *
+   * @generated from enum value: TERMINAL_KIND_TRANSPORT_LOST = 3;
+   */
+  TRANSPORT_LOST = 3,
+
+  /**
+   * TERMINAL_KIND_CLOSED identifies a bare remote close without completion.
+   *
+   * @generated from enum value: TERMINAL_KIND_CLOSED = 4;
+   */
+  CLOSED = 4,
+
+  /**
+   * TERMINAL_KIND_ABANDONED identifies owner-context expiry without a remote terminal.
+   *
+   * @generated from enum value: TERMINAL_KIND_ABANDONED = 5;
+   */
+  ABANDONED = 5,
+}
+
+export const TerminalKind_Enum = /* @__PURE__ */ createEnumType(
+  'srpc.TerminalKind',
+  [
+    [0, 'TERMINAL_KIND_UNSPECIFIED'],
+    [1, 'TERMINAL_KIND_COMMITTED'],
+    [2, 'TERMINAL_KIND_CANCELED'],
+    [3, 'TERMINAL_KIND_TRANSPORT_LOST'],
+    [4, 'TERMINAL_KIND_CLOSED'],
+    [5, 'TERMINAL_KIND_ABANDONED'],
+  ],
+)
+
 /**
  * CallStart requests starting a new RPC call.
  *

package/srpc/rpcproto.proto

@@ -1,6 +1,22 @@
 syntax = "proto3";
 package srpc;
 
+// TerminalKind is the terminal state of a held unary invocation.
+enum TerminalKind {
+  // TERMINAL_KIND_UNSPECIFIED is not a valid terminal state.
+  TERMINAL_KIND_UNSPECIFIED = 0;
+  // TERMINAL_KIND_COMMITTED identifies an explicit remote CallData completion.
+  TERMINAL_KIND_COMMITTED = 1;
+  // TERMINAL_KIND_CANCELED identifies a remote CallCancel packet.
+  TERMINAL_KIND_CANCELED = 2;
+  // TERMINAL_KIND_TRANSPORT_LOST identifies a remote error or transport failure.
+  TERMINAL_KIND_TRANSPORT_LOST = 3;
+  // TERMINAL_KIND_CLOSED identifies a bare remote close without completion.
+  TERMINAL_KIND_CLOSED = 4;
+  // TERMINAL_KIND_ABANDONED identifies owner-context expiry without a remote terminal.
+  TERMINAL_KIND_ABANDONED = 5;
+}
+
 // Packet is a message sent over a srpc packet connection.
 message Packet {
   // Body is the packet body.

package/srpc/schema-ownership_test.go

@@ -0,0 +1,115 @@
+package srpc
+
+import (
+	"go/ast"
+	"go/parser"
+	"go/token"
+	"os"
+	"strings"
+	"testing"
+)
+
+// handwrittenTerminalConst names the parallel iota constants the receipt
+// post-mortem removed. Their reappearance signals a second handwritten owner of
+// the cross-language terminal vocabulary.
+var handwrittenTerminalConst = map[string]bool{
+	"TerminalCommitted": true,
+	"TerminalCanceled":  true,
+	"TerminalLost":      true,
+	"TerminalClosed":    true,
+	"TerminalAbandoned": true,
+}
+
+// handwrittenTerminalKindOwners returns the source files that declare the shared
+// TerminalKind vocabulary by hand instead of consuming the generated rpcproto
+// owner. The cross-language terminal noun has exactly one schema owner; a
+// handwritten type or iota constant reintroduces the parallel owner.
+func handwrittenTerminalKindOwners(t *testing.T, files map[string]string) []string {
+	t.Helper()
+	var owners []string
+	for name, src := range files {
+		fset := token.NewFileSet()
+		file, err := parser.ParseFile(fset, name, src, 0)
+		if err != nil {
+			t.Fatalf("parse %s: %v", name, err)
+		}
+		if declaresTerminalKindByHand(file) {
+			owners = append(owners, name)
+		}
+	}
+	return owners
+}
+
+// declaresTerminalKindByHand reports whether a file declares the TerminalKind
+// type or one of its removed iota constants.
+func declaresTerminalKindByHand(file *ast.File) bool {
+	for _, decl := range file.Decls {
+		gen, ok := decl.(*ast.GenDecl)
+		if !ok {
+			continue
+		}
+		for _, spec := range gen.Specs {
+			switch s := spec.(type) {
+			case *ast.TypeSpec:
+				if s.Name.Name == "TerminalKind" {
+					return true
+				}
+			case *ast.ValueSpec:
+				for _, id := range s.Names {
+					if handwrittenTerminalConst[id.Name] {
+						return true
+					}
+				}
+			}
+		}
+	}
+	return false
+}
+
+// packageSourceFiles reads the non-generated, non-test Go sources of the current
+// package directory.
+func packageSourceFiles(t *testing.T) map[string]string {
+	t.Helper()
+	entries, err := os.ReadDir(".")
+	if err != nil {
+		t.Fatalf("read package dir: %v", err)
+	}
+	files := map[string]string{}
+	for _, entry := range entries {
+		name := entry.Name()
+		if !strings.HasSuffix(name, ".go") {
+			continue
+		}
+		if strings.HasSuffix(name, ".pb.go") || strings.HasSuffix(name, "_test.go") {
+			continue
+		}
+		data, err := os.ReadFile(name)
+		if err != nil {
+			t.Fatalf("read %s: %v", name, err)
+		}
+		files[name] = string(data)
+	}
+	return files
+}
+
+// TestTerminalKindHasSingleSchemaOwner proves no handwritten srpc source owns
+// the cross-language TerminalKind vocabulary alongside the generated owner.
+func TestTerminalKindHasSingleSchemaOwner(t *testing.T) {
+	owners := handwrittenTerminalKindOwners(t, packageSourceFiles(t))
+	if len(owners) != 0 {
+		t.Fatalf("TerminalKind must come from generated rpcproto; handwritten owners: %v", owners)
+	}
+}
+
+// TestTerminalKindGuardDetectsHandwrittenOwner proves the guard fires when a
+// parallel handwritten TerminalKind owner regresses into the package.
+func TestTerminalKindGuardDetectsHandwrittenOwner(t *testing.T) {
+	bad := map[string]string{
+		"server-invocation.go": "package srpc\n\n" +
+			"type TerminalKind int\n\n" +
+			"const (\n\tTerminalCommitted TerminalKind = iota\n)\n",
+	}
+	if owners := handwrittenTerminalKindOwners(t, bad); len(owners) == 0 {
+		t.Fatal("guard failed to flag a handwritten TerminalKind owner")
+	}
+}

package/srpc/server-invocation.go

@@ -1,24 +1,6 @@
 package srpc
 
-import (
-	"context"
-)
-
-// TerminalKind is the terminal state of a held unary invocation.
-type TerminalKind int
-
-const (
-	// TerminalCommitted identifies an explicit remote CallData completion.
-	TerminalCommitted TerminalKind = iota
-	// TerminalCanceled identifies a remote CallCancel packet.
-	TerminalCanceled
-	// TerminalLost identifies a remote error or transport failure.
-	TerminalLost
-	// TerminalClosed identifies a bare remote close without completion.
-	TerminalClosed
-	// TerminalAbandoned identifies owner-context expiry without a remote terminal.
-	TerminalAbandoned
-)
+import "context"
 
 // ServerInvocation exposes the terminal of a held unary server invocation.
 type ServerInvocation interface {

package/srpc/server-invocation.ts

@@ -1,10 +1,4 @@
-// TerminalKind is the terminal state of a held unary invocation.
-export type TerminalKind =
-  | 'committed'
-  | 'canceled'
-  | 'transportLost'
-  | 'closed'
-  | 'abandoned'
+import type { TerminalKind } from './rpcproto.pb.js'
 
 // ServerInvocation exposes the invocation signal and terminal wait.
 export class ServerInvocation implements AbortSignal {

package/srpc/stream-yamux.go

@@ -4,7 +4,7 @@ import (
 	"errors"
 	"time"
 
-	yamux "github.com/libp2p/go-yamux/v4"
+	yamux "github.com/libp2p/go-yamux/v5"
 )
 
 // yamuxStream wraps a yamux.Stream to implement MuxedStream.

package/srpc/websocket.go

@@ -4,7 +4,7 @@ import (
 	"context"
 
 	"github.com/aperturerobotics/go-websocket"
-	"github.com/libp2p/go-yamux/v4"
+	"github.com/libp2p/go-yamux/v5"
 )
 
 // NewWebSocketConn wraps a websocket into a MuxedConn.