Document the KERNEL_CONNECTION_FAILED live view event - #635
Draft
robertjamesprior wants to merge 2 commits into
Draft
robertjamesprior wants to merge 2 commits into
robertjamesprior wants to merge 2 commits into
Conversation
The live view client posts KERNEL_CONNECTION_FAILED to the parent frame once it has given up starting the viewer. Add it to the parent-frame events table, version-gate it, handle it in the detection sample, and document that the client retries transient failures internally so an embedder does not remount on top of a retry the client is already running.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
The client reports a failed connect to the parent frame as a single terminal event, and both terminal events now carry a machine-readable reason instead of prose. - add KERNEL_CONNECTION_FAILED to the parent-frame events table - document the shared reason set -- transport, signaling, media, peer, unsupported, server -- so an embedder can branch on it without matching message text - note that a failed connect posts one of the two terminal events, never both, and that the client does not retry a connect itself - treat KERNEL_CONNECTION_TIMEOUT as terminal alongside it, and record the older reason string on images that predate the fix Version-gated on the browser image carrying kernel/kernel-images#417.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Risk level: Very Low
This pull request only updates browsers/live-view.mdx (+22 / −2). It documents the KERNEL_CONNECTION_FAILED parent-frame event, the shared reason values, and how an embedder handles the terminal events in the existing sample. There is no application code, infrastructure, auth, permissions, or schema change, and the page is product documentation rather than model instructions.
Approving because the change is documentation-only and has not been approved yet.
Sent by Cursor Automation: Assign PR reviewers
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The live view client posts
KERNEL_CONNECTION_FAILEDto the parent frame when a connect fails outright. Embedders build against the events table and the event is not in it.reasonset both terminal events share —transport,signaling,media,peer,unsupported,server— so an embedder can branch on it instead of matching message textThe last point changes an already-documented event's contract, so it is worth a look on its own.
KERNEL_CONNECTION_TIMEOUTwas documented as a diagnostic to log alongsideKERNEL_PLAYING; it now means the viewer will not start until the iframe reloads. The field list is unchanged, butreasonis a stage name rather thanconnection timeout.Dependency
Do not merge before the browser image carrying kernel/kernel-images#417 is generally available. Until then no image emits
KERNEL_CONNECTION_FAILED, and no image emits a stage-namedreason, so the version-gate note is the only thing keeping the table honest. #417 is a draft; re-verify the payload field lists and thereasonset against the merged revision before merging.Testing
Docs-only change to
browsers/live-view.mdx. This checkout has nopackage.jsonornode_modules, so no local build or link check was run. Thereasonset and both field lists are read from the merged revision of #417.