@ai-matrx/desktop-protocol 0.21.79 → 0.21.80

package/CHANGELOG.md

@@ -1,10 +1,21 @@
 # Changelog
 
-## 0.21.79
+## 0.21.80
 
 UNVERIFIED: this release has no Unreleased entry and the source comparison could not be made (the caller supplied no source comparison). Whether source changed is unknown; consumer action is unknown.
 Check the package's gitHead on npm against this version's gitHead: `git diff <previous gitHead> <this gitHead> -- apps/shared/desktop-protocol/src`.
 
+## 0.21.79
+
+SOURCE CHANGED WITH NO RELEASE NOTE. This release shipped source changes that nobody described in an Unreleased entry,
+so they may include breaking API changes. Consumer action is UNKNOWN: read the diff before upgrading.
+Diff: `git diff dc95f05a68 e6fc2655c1 -- apps/shared/desktop-protocol/src`
+
+Changed shipped source files (3):
+- `apps/shared/desktop-protocol/src/contract.ts`
+- `apps/shared/desktop-protocol/src/schema/coding.ts`
+- `apps/shared/desktop-protocol/src/schema/primitives.ts`
+
 ## 0.21.78
 
 SOURCE CHANGED WITH NO RELEASE NOTE. This release shipped source changes that nobody described in an Unreleased entry,

package/dist/client.cjs

@@ -5206,6 +5206,7 @@ function createDesktopClient(options) {
   const makeSocket = options.webSocket ?? defaultWebSocket();
   const heartbeatMs = options.heartbeatMs ?? 25e3;
   const requestTimeoutMs = options.requestTimeoutMs ?? 7e4;
+  const firstFrameMs = options.firstFrameMs ?? requestTimeoutMs;
   const protocolVersion = options.protocolVersion ?? `${PROTOCOL_MAJOR}.${PROTOCOL_MINOR}`;
   const backoff = (0, import_realtime.createBackoff)({ ...options.backoff, now: timers.now });
   const diagnose = options.onDiagnostic ?? ((d) => {
@@ -5243,6 +5244,7 @@ function createDesktopClient(options) {
   let probeTimer = null;
   let lastHeardAt = 0;
   let heardCount = 0;
+  let pongs = 0;
   let closedByUser = false;
   const newId = (prefix) => `${prefix}${(++nextId).toString(36)}`;
   function setState(patch) {
@@ -5290,6 +5292,7 @@ function createDesktopClient(options) {
     ws.onopen = () => {
       if (generation !== socketGeneration) return;
       lastHeardAt = timers.now();
+      pongs = 0;
       helloId = newId("h");
       setState({ status: "handshaking" });
       sendJson({ type: "hello", id: helloId, protocolVersion, clientType: options.clientType, clientVersion: options.clientVersion });
@@ -5305,6 +5308,8 @@ function createDesktopClient(options) {
     };
     ws.onclose = (event) => {
       if (generation !== socketGeneration) return;
+      const ev = event;
+      reportClose(ev.code, ev.reason ?? "", ev.wasClean ?? false);
       onSocketGone(generation, event.code, null);
     };
   }
@@ -5316,6 +5321,7 @@ function createDesktopClient(options) {
       const silentMs = timers.now() - lastHeardAt;
       if (silentMs >= heartbeatMs * 2) {
         diagnose({ kind: "heartbeat_timeout", silentMs });
+        reportClose(null, "heartbeat timeout", false);
         const dead = socket;
         onSocketGone(generation, null, new DesktopProtocolError("TIMEOUT", "Connection went silent", { retryable: true }));
         try {
@@ -5328,6 +5334,9 @@ function createDesktopClient(options) {
       scheduleHeartbeat(generation);
     }, heartbeatMs);
   }
+  function reportClose(code, reason, wasClean) {
+    diagnose({ kind: "socket_closed", code, reason: reason.slice(0, 120), wasClean, idleSinceLastRxMs: Math.max(0, timers.now() - lastHeardAt), pongs });
+  }
   function onSocketGone(generation, code, error) {
     if (generation !== socketGeneration) return;
     socketGeneration++;
@@ -5416,7 +5425,10 @@ function createDesktopClient(options) {
   }
   function onMessage(data) {
     if (typeof data === "string") {
-      if (data === PONG_TEXT) return;
+      if (data === PONG_TEXT) {
+        pongs++;
+        return;
+      }
       let json;
       try {
         json = JSON.parse(data);
@@ -5447,6 +5459,10 @@ function createDesktopClient(options) {
     onFrame(frame.header, frame.payload);
   }
   function onEnvelope(msg) {
+    if (msg.type !== "event") {
+      const heard = streams.get(msg.id);
+      if (heard) clearFirstFrame(heard);
+    }
     switch (msg.type) {
       case "response": {
         if (msg.id === helloId) return onWelcome(msg.result);
@@ -5588,6 +5604,7 @@ function createDesktopClient(options) {
       diagnose({ kind: "unknown_stream", sid: header.sid });
       return;
     }
+    clearFirstFrame(s);
     const isData = header.channel === FrameChannel.DATA || header.channel === FrameChannel.STDERR;
     const isSnapshot = header.channel === FrameChannel.SNAPSHOT;
     if (!isData && !isSnapshot) {
@@ -5633,8 +5650,29 @@ function createDesktopClient(options) {
       socket.send(encodeFrame({ version: FRAME_VERSION, flags: 0, channel: FrameChannel.STDIN, cid: 0, sid: s.sid, seq: s.sendSeq }, chunk));
     }
   }
+  function clearFirstFrame(s) {
+    if (s.firstFrameTimer === null) return;
+    timers.clearTimeout(s.firstFrameTimer);
+    s.firstFrameTimer = null;
+  }
+  function armFirstFrame(s) {
+    clearFirstFrame(s);
+    const waitMs = s.options.firstFrameMs ?? firstFrameMs;
+    const id = s.id;
+    s.firstFrameTimer = timers.setTimeout(() => {
+      s.firstFrameTimer = null;
+      if (s.ended || s.id !== id) return;
+      diagnose({ kind: "first_frame_timeout", id, op: s.op, waitedMs: waitMs });
+      streams.delete(id);
+      if (s.sid !== null) bySid.delete(s.sid);
+      abandon(id);
+      endStream(s, null, new DesktopProtocolError("TIMEOUT", `${s.op}: no answer within ${waitMs} ms`, { retryable: true }));
+      wake();
+    }, waitMs);
+  }
   function endStream(s, reason, error) {
     if (s.ended) return;
+    clearFirstFrame(s);
     s.ended = true;
     s.sendQueue = [];
     if (!s.resultSettled) {
@@ -5657,7 +5695,7 @@ function createDesktopClient(options) {
     const params = { resource_id: s.resourceId, mode: s.options.mode ?? "control" };
     if (s.lastSeq > 0) params.since_seq = s.lastSeq;
     if (s.options.windowBytes !== void 0) params.window_bytes = s.options.windowBytes;
-    sendJson({ id, type: "request", cap: "session", op: "attach", params });
+    if (sendJson({ id, type: "request", cap: "session", op: "attach", params })) armFirstFrame(s);
   }
   function safeCall(where, fn) {
     try {
@@ -5766,7 +5804,8 @@ function createDesktopClient(options) {
       resolveDone,
       rejectDone,
       ended: false,
-      reattaching: false
+      reattaching: false,
+      firstFrameTimer: null
     };
     const start = async () => {
       let welcome;
@@ -5785,7 +5824,9 @@ function createDesktopClient(options) {
       if (!sendJson({ id: s.id, type: "request", ...capOf(op), params: wire })) {
         streams.delete(s.id);
         endStream(s, null, new DesktopProtocolError("DEVICE_OFFLINE", "Connection lost", { retryable: true }));
+        return;
       }
+      armFirstFrame(s);
     };
     void start();
     opts.signal?.addEventListener("abort", () => handle.cancel(), { once: true });
@@ -5861,6 +5902,7 @@ function createDesktopClient(options) {
       if (heardCount > heardBefore) return;
       const silentMs = timers.now() - lastHeardAt;
       diagnose({ kind: "heartbeat_timeout", silentMs });
+      reportClose(null, "wake probe timeout", false);
       const dead = socket;
       onSocketGone(generation, null, new DesktopProtocolError("TIMEOUT", "Connection went silent", { retryable: true }));
       try {