statewire 0.16.0 → 0.17.0

package/src/client/connection.ts

@@ -1,3 +1,9 @@
+import {
+  negotiationHeaders,
+  validateSelection,
+  parseNegotiation,
+} from "../wire/protocol";
+import type { StatewireProtocol } from "../wire/protocol";
 import { useEffect, useRef, useState } from "react";
 import { flushTapSync } from "@assistant-ui/tap";
 import { reviveOps, reviveValue } from "../wire/meta";
@@ -39,6 +45,8 @@ export type StatewireCmd = {
 };
 
 export type StatewireSyn = {
+  version?: string;
+  protocols?: StatewireProtocol.Selection["protocols"];
   seq?: number;
   ctxSeq?: number;
   record?: "ephemeral";
@@ -95,6 +103,7 @@ const openGate = (g: Gate) => {
 export type AttemptOutcome = "stop" | "reattach" | "ended" | "idle";
 
 export type Conn = {
+  negotiation?: StatewireProtocol.Options;
   connection: StatewireClient.Connection;
   parked: boolean;
   lease: string | null;
@@ -283,7 +292,6 @@ const cmdsOf = (env: StatewireEnvelope): StatewireCmd[] => {
 const snapshotOf = (env: StatewireEnvelope): unknown[] => {
   const ops = env.ops;
   if (ops === undefined) return protocolError("hello missing snapshot");
-  if (ops.length === 0) return protocolError("hello missing snapshot");
   return reviveOps(ops);
 };
 
@@ -298,6 +306,7 @@ const helloSynOf = (env: StatewireEnvelope): StatewireSyn => {
 
 const handleHello = (c: Conn, env: StatewireEnvelope) => {
   const syn = helloSynOf(env);
+  if (c.negotiation !== undefined) validateSelection(syn, c.negotiation);
   const ops = snapshotOf(env);
   c.ctx.onHello({
     ops,
@@ -323,7 +332,12 @@ const warnUnknownSynFact = () => {
 const deliverSyn = (c: Conn, value: unknown) => {
   if (!isObject(value)) return protocolError("syn must be an object");
   validateSynScalars(value);
-  if (value["record"] !== undefined || value["idle"] !== undefined) {
+  if (
+    value["version"] !== undefined ||
+    value["protocols"] !== undefined ||
+    value["record"] !== undefined ||
+    value["idle"] !== undefined
+  ) {
     protocolError("invalid mid-stream syn");
   }
   if (
@@ -578,6 +592,12 @@ export const attachFrame = async (
   headers: StatewireClient.HeadersOption | undefined,
 ) => {
   const resolved = await resolveHeaders(headers, c.authStale);
+  for (const [name, value] of Object.entries(
+    negotiationHeaders(c.negotiation ?? {}),
+  )) {
+    if (!resolved.has(name)) resolved.set(name, value);
+  }
+  c.negotiation = parseNegotiation(resolved);
   c.authStale = false;
   const lanes = flushTapSync(() => c.ctx.takeAttachLanes());
   return {
@@ -589,15 +609,17 @@ export const attachFrame = async (
   };
 };
 
-export const useLink = (props: {
-  url: string;
-  isNew?: boolean | undefined;
-  onChange?: ((connection: StatewireClient.Connection) => void) | undefined;
-  onError?: ((error: StatewireClient.ConnectionError) => void) | undefined;
-  ctx: StatewireRemoteProps;
-  attemptOnce: (c: Conn, abort: AbortController) => Promise<AttemptOutcome>;
-  send: (c: Conn, frame: StatewireFrame) => Promise<StatewireSubmitResult>;
-}): RemoteLink => {
+export const useLink = (
+  props: StatewireProtocol.Options & {
+    url: string;
+    isNew?: boolean | undefined;
+    onChange?: ((connection: StatewireClient.Connection) => void) | undefined;
+    onError?: ((error: StatewireClient.ConnectionError) => void) | undefined;
+    ctx: StatewireRemoteProps;
+    attemptOnce: (c: Conn, abort: AbortController) => Promise<AttemptOutcome>;
+    send: (c: Conn, frame: StatewireFrame) => Promise<StatewireSubmitResult>;
+  },
+): RemoteLink => {
   const latest = useRef(props);
   latest.current = props;
   const [, setConnection] = useState<StatewireClient.Connection | null>(null);
@@ -622,7 +644,10 @@ export const useLink = (props: {
       },
       onError: (error) => latest.current.onError?.(error),
       onChange: (connection) => latest.current.onChange?.(connection),
-      attemptOnce: (abort) => latest.current.attemptOnce(conn, abort),
+      attemptOnce: (abort) => {
+        conn.negotiation = latest.current;
+        return latest.current.attemptOnce(conn, abort);
+      },
       notify: setConnection,
       reconnect: () => reconnectConn(conn),
       connection: {
@@ -647,6 +672,11 @@ export const useLink = (props: {
     }),
   );
 
+  const negotiation = JSON.stringify([
+    props.protocol,
+    props.wireVersion,
+    props.applicationProtocols,
+  ]);
   useEffect(() => {
     c.lease = null;
     c.attempt = 0;
@@ -671,7 +701,7 @@ export const useLink = (props: {
       if (c.lifetime === lifetime) c.lifetime = null;
       openGate(c.gate);
     };
-  }, [c, props.url]);
+  }, [c, props.url, negotiation]);
 
   return link;
 };

package/src/client/core.ts

@@ -119,6 +119,11 @@ const recompute = (c: Core) => {
     for (const overlay of c.overlays) {
       if (overlay.dropped) continue;
       const { inv } = overlay;
+      if (
+        inv.protocol !== undefined &&
+        inv.protocol !== (c.getOptions().protocol ?? "default")
+      )
+        continue;
       const ctx: StatewireClient.OptimisticContext = {
         ts: inv.ts,
         seq: inv.seq,
@@ -235,6 +240,7 @@ const note = (
 ) => {
   if (!c.getOptions().onCommandChange) return;
   c.updates.push({
+    ...(inv.protocol !== undefined && { protocol: inv.protocol }),
     method: inv.method,
     params: inv.params as never[],
     seq: inv.seq,