@gradio/client 2.2.1 → 2.2.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @gradio/client
 
+## 2.2.2
+
+### Fixes
+
+- [#13500](https://github.com/gradio-app/gradio/pull/13500) [`751a397`](https://github.com/gradio-app/gradio/commit/751a397ce519732526863ee84e311f7f64195f9d) - Close iterator on terminal error in JS client.  Thanks @hysts!
+
 ## 2.2.1
 
 ### Fixes

package/dist/browser.js

@@ -1532,7 +1532,7 @@ function Xt(e, s = {}, t, n, o, r) {
               fn_index: d,
               time: /* @__PURE__ */ new Date(),
               visible: !0
-            });
+            }), a();
           else if (q === 422)
             i({
               type: "status",
@@ -1557,7 +1557,7 @@ function Xt(e, s = {}, t, n, o, r) {
               fn_index: d,
               time: /* @__PURE__ */ new Date(),
               visible: !0
-            });
+            }), a();
           } else {
             v = b.event_id, I = v;
             let P = async function(ie) {
@@ -1634,7 +1634,7 @@ function Xt(e, s = {}, t, n, o, r) {
                   queue: !0,
                   endpoint: _,
                   fn_index: d
-                }), a())), ($?.stage === "complete" || $?.stage === "error") && (se[v] && delete se[v], v in te && delete te[v]);
+                }), a())), ($?.stage === "complete" || $?.stage === "error") && (se[v] && delete se[v], v in te && delete te[v], a());
               } catch (S) {
                 console.error("Unexpected client exception", S), i({
                   type: "status",

package/dist/index.js

@@ -1940,6 +1940,7 @@ function submit(endpoint, data = {}, event_data, trigger_id, all_events, additio
               time: /* @__PURE__ */ new Date(),
               visible: true
             });
+            close();
           } else if (status === 422) {
             fire_event({
               type: "status",
@@ -1966,6 +1967,7 @@ function submit(endpoint, data = {}, event_data, trigger_id, all_events, additio
               time: /* @__PURE__ */ new Date(),
               visible: true
             });
+            close();
           } else {
             event_id = response.event_id;
             event_id_final = event_id;
@@ -2066,6 +2068,7 @@ function submit(endpoint, data = {}, event_data, trigger_id, all_events, additio
                   if (event_id in pending_diff_streams) {
                     delete pending_diff_streams[event_id];
                   }
+                  close();
                 }
               } catch (e) {
                 console.error("Unexpected client exception", e);

package/dist/utils/submit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"submit.d.ts","sourceRoot":"","sources":["../../src/utils/submit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAGX,WAAW,EAMX,cAAc,EACd,MAAM,UAAU,CAAC;AAkBlB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,wBAAgB,MAAM,CACrB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,IAAI,GAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAC9C,UAAU,CAAC,EAAE,OAAO,EACpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,EAC1B,UAAU,CAAC,EAAE,OAAO,EACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACzC,cAAc,CAAC,WAAW,CAAC,CAiqB7B"}
+{"version":3,"file":"submit.d.ts","sourceRoot":"","sources":["../../src/utils/submit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAGX,WAAW,EAMX,cAAc,EACd,MAAM,UAAU,CAAC;AAkBlB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,wBAAgB,MAAM,CACrB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,IAAI,GAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAC9C,UAAU,CAAC,EAAE,OAAO,EACpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,EAC1B,UAAU,CAAC,EAAE,OAAO,EACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACzC,cAAc,CAAC,WAAW,CAAC,CAoqB7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradio/client",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Gradio API client",
   "type": "module",
   "main": "dist/index.js",

package/src/test/submit.test.ts

@@ -89,4 +89,65 @@ describe("submit iterator", () => {
 		expect(types).toContain("data");
 		expect(types).toContain("status");
 	});
+
+	test("for-await loop terminates when the server raises an error mid-stream", async () => {
+		const app = await Client.connect("hmb/hello_world", {
+			events: ["data", "status"]
+		});
+		app.stream_status.open = true;
+
+		const iterator = app.submit("/predict", ["hi"]);
+		const event_id = await iterator.wait_for_id();
+		expect(event_id).toBeTruthy();
+
+		const callback = app.event_callbacks[event_id as string];
+		expect(callback).toBeDefined();
+
+		const events: { type: string; stage?: string }[] = [];
+		const consumer = (async () => {
+			for await (const event of iterator) {
+				events.push(event as { type: string; stage?: string });
+			}
+		})();
+
+		await new Promise((r) => setTimeout(r, 0));
+
+		// Stream a partial result first, so the error below genuinely arrives
+		// mid-stream rather than as the very first message.
+		await callback({
+			msg: "process_generating",
+			output: { data: ["partial"] },
+			success: true
+		});
+
+		// A server-side exception then arrives as process_completed with
+		// success:false and an `error` field in the output. This must fire an
+		// "error" status and terminate the iterator rather than hang the
+		// consumer. handle_message() reads title/visible/duration from
+		// `output`, so mirror a real payload's shape here.
+		await callback({
+			msg: "process_completed",
+			output: {
+				error: "boom mid-stream",
+				title: "Error",
+				visible: true,
+				duration: 0
+			},
+			success: false
+		});
+
+		await race_with_timeout(
+			consumer,
+			1000,
+			"submit iterator did not terminate after a server-side error"
+		);
+
+		// The partial result should have been delivered before the error.
+		expect(events.some((e) => e.type === "data")).toBe(true);
+
+		const error_event = events.find(
+			(e) => e.type === "status" && e.stage === "error"
+		);
+		expect(error_event).toBeDefined();
+	});
 });

package/src/utils/submit.ts

@@ -452,6 +452,7 @@ export function submit(
 							time: new Date(),
 							visible: true
 						});
+						close();
 					} else if (status === 422) {
 						fire_event({
 							type: "status",
@@ -481,6 +482,7 @@ export function submit(
 							time: new Date(),
 							visible: true
 						});
+						close();
 					} else {
 						event_id = response.event_id as string;
 						event_id_final = event_id;
@@ -593,6 +595,7 @@ export function submit(
 									if (event_id! in pending_diff_streams) {
 										delete pending_diff_streams[event_id!];
 									}
+									close();
 								}
 							} catch (e) {
 								console.error("Unexpected client exception", e);