Skip to content

doc: clarify QUIC async write backpressure - #65947

Open
johnfinnerty-nz wants to merge 2 commits into
nodejs:mainfrom
johnfinnerty-nz:jftc/issue-63305-quic-docs
Open

doc: clarify QUIC async write backpressure#65947
johnfinnerty-nz wants to merge 2 commits into
nodejs:mainfrom
johnfinnerty-nz:jftc/issue-63305-quic-docs

Conversation

@johnfinnerty-nz

Copy link
Copy Markdown

Summary

Document strict async write behavior, ERR_INVALID_STATE, canWrite, and onblocked.

Validation

Documentation was checked against the current implementation; git diff --check passed.

Closes #63305

Signed-off-by: John Finnerty <297514060+johnfinnerty-nz@users.noreply.github.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/quic

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. quic Issues and PRs related to the QUIC transport implementation. labels Sep 9, 2026
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Welcome to Node.js, and thank you for your first contribution!

Before review, please take a moment to read:

Please make sure every commit is signed off. For a first pull request, GitHub Actions require collaborator approval and Jenkins CI must be started by a collaborator or triager, so an initial wait is normal.

Caution

AgentScan found account activity patterns that may be consistent with automation. This is a heuristic, not proof that this pull request was opened by an agent or violates policy. AI-assisted contributions are permitted, but automated tooling must not open pull requests without advance approval, and contributors must personally understand, test, verify, and take responsibility for every submitted change. See the AgentScan analysis, AI use policy, and automation policy for additional context.

@jasnell

jasnell commented Sep 10, 2026

Copy link
Copy Markdown
Member

@johnfinnerty-nz ... While the change here looks fine and is acceptable, if you make future additional contributions, please do ensure that the PR description is not just AI generated. We need to know that the contribution comes from a person, not an AI agent.

@johnfinnerty-nz

Copy link
Copy Markdown
Author

Cheers James. I did use Codex, including to polish my description, as grammar isn’t my strong suit. I reviewed the code before submitting. The change clarifies that asynchronous QUIC writes reject with ERR_INVALID_STATE when the buffer is full, rather than waiting for capacity. I’ll make sure future descriptions explain the reasoning in my own words. Thanks again for the review and feedback.

@MikeMcC399 MikeMcC399 added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Sep 10, 2026
Distinguish writer capacity from transport blocking and stop retrying when no drain wait is available.

Assisted-by: Codex
Signed-off-by: John Finnerty <297514060+johnfinnerty-nz@users.noreply.github.com>
@MikeMcC399 MikeMcC399 removed the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agentscan:automated-account doc Issues and PRs related to Node.js documentation. quic Issues and PRs related to the QUIC transport implementation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

quic: Documentation on async write on QuicStream

5 participants