From 53080581cbef16b55cc8201054127232293c799b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel?= Date: Tue, 17 Nov 2026 08:04:58 +0000 Subject: [PATCH] fix(cli): a refused reverse start reports whether HeyGen sent the refusal (#8053) * fix(cli): a refused reverse start reports whether HeyGen sent the refusal * fix(cli): a refusal body that is not JSON is never read * refactor(cli): drop the comments the names already say * refactor(cli): reading a refusal's source lives in one helper --- packages/cli/src/heygen/reverse.test.ts | 27 ++++++++++++++++++++++++- packages/cli/src/heygen/reverse.ts | 13 +++++++++++- packages/cli/src/telemetry/events.ts | 8 +++++++- 3 files changed, 45 insertions(+), 3 deletions(-) diff --git a/packages/cli/src/heygen/reverse.test.ts b/packages/cli/src/heygen/reverse.test.ts index 7176069a73..d94b7c91e1 100644 --- a/packages/cli/src/heygen/reverse.test.ts +++ b/packages/cli/src/heygen/reverse.test.ts @@ -162,7 +162,32 @@ describe("startReverseSession", () => { ])("reports status %i as %s", async (status, cause) => { serve({ [START_URL]: () => new Response("no", { status }) }); expect(await startReverseSession()).toMatchObject({ recorded: false, cause }); - expect(track).toHaveBeenCalledExactlyOnceWith({ cause, status }); + expect(track).toHaveBeenCalledExactlyOnceWith({ cause, status, heygenBody: false }); + }); + + it.each([ + ["HeyGen's v1 body", { code: 40102, message: "Unauthorized" }, true], + ["HeyGen's error body", { data: null, error: { code: "unauthorized", message: "no" } }, true], + ["a proxy's JSON", { error: "blocked by policy" }, false], + ["a JSON array", [403], false], + ])("says whether a refusal came from HeyGen: %s", async (_name, body, heygenBody) => { + serve({ [START_URL]: () => Response.json(body, { status: 403 }) }); + await startReverseSession(); + expect(track).toHaveBeenCalledExactlyOnceWith({ cause: "http_4xx", status: 403, heygenBody }); + }); + + it("never reads a refusal body that is not JSON, however it looks", async () => { + const page = '{"code": 40102}'; + serve({ + [START_URL]: () => + new Response(page, { status: 403, headers: { "content-type": "text/html" } }), + }); + await startReverseSession(); + expect(track).toHaveBeenCalledExactlyOnceWith({ + cause: "http_4xx", + status: 403, + heygenBody: false, + }); }); it("reports a network failure", async () => { diff --git a/packages/cli/src/heygen/reverse.ts b/packages/cli/src/heygen/reverse.ts index bd1517f5e4..33e779b4ca 100644 --- a/packages/cli/src/heygen/reverse.ts +++ b/packages/cli/src/heygen/reverse.ts @@ -54,6 +54,15 @@ function parseSession(body: unknown): ReverseSession | undefined { return { sessionId, plan, gate, ...upgradeUrl }; } +async function refusedByHeygen(res: Response): Promise { + if (!res.headers.get("content-type")?.includes("json")) return false; + const body: unknown = await res.json().catch(() => null); + if (!isRecord(body)) return false; + return ( + typeof body.code === "number" || (isRecord(body.error) && typeof body.error.code === "string") + ); +} + /** The plan from the subscription route, for when the reverse route cannot answer. */ async function fallbackPlan(): Promise<"free" | "pro" | undefined> { const plan = await readPlan(); @@ -87,6 +96,7 @@ export async function startReverseSession( } let cause: ReverseUnrecordedCause; let status: number | undefined; + let heygenBody: boolean | undefined; try { const res = await fetch(`${api2BaseUrl()}/v1/hyperframes/reverse/start`, { method: "POST", @@ -104,11 +114,12 @@ export async function startReverseSession( } else { status = res.status; cause = res.status >= 500 ? "http_5xx" : res.status >= 400 ? "http_4xx" : "http_other"; + heygenBody = await refusedByHeygen(res); } } catch { cause = "network"; } - trackReverseStartUnrecorded({ cause, status }); + trackReverseStartUnrecorded({ cause, status, heygenBody }); const plan = await fallbackPlan().catch(() => undefined); return { recorded: false, reason: "unavailable", cause, ...(plan ? { plan } : {}) }; } diff --git a/packages/cli/src/telemetry/events.ts b/packages/cli/src/telemetry/events.ts index e280c962f7..36268734a2 100644 --- a/packages/cli/src/telemetry/events.ts +++ b/packages/cli/src/telemetry/events.ts @@ -1023,8 +1023,14 @@ export type ReverseUnrecordedCause = export function trackReverseStartUnrecorded(props: { cause: ReverseUnrecordedCause; status?: number; + /** An error status only: whether HeyGen's API wrote the body, or something between (a proxy, a firewall). */ + heygenBody?: boolean; }): void { - trackEvent("cli_reverse_start_unrecorded", { cause: props.cause, status: props.status }); + trackEvent("cli_reverse_start_unrecorded", { + cause: props.cause, + status: props.status, + heygen_body: props.heygenBody, + }); } export function trackSkillCommandRan(props: {