docs(specs): define the normative popup transport - #22
Open
Wondertan wants to merge 35 commits into
Open
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Rendered entry points:
Motivation
The popup transport's normative rules were interleaved with implementation detail: carrier wire formats, the port keeper, timeouts, API declarations, and diagnostics. Decoupling them keeps each side tidy, but the main reason is layering. Protocol specifications built on top of the popup transport, starting with the ceremony browser contract, need a stable normative description to reference by requirement ID rather than restating browser mechanics or depending on how one package implements them.
Scope
Normative transport only. The
@libid/popuppackage documentation (API, MessagePort and WebRTC carriers, port keeper, test plan, metrics) travels with the implementation in #25. Carrier wire formats are not an interoperability boundary today and stay with the implementation.