Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

streamResetBurst and streamResetRate options are missing in the documentation of http2.createSecureServer #57169

Closed
gunters63 opened this issue Feb 21, 2025 · 2 comments
Closed

streamResetBurst and streamResetRate options are missing in the documentation of http2.createSecureServer #57169

gunters63 opened this issue Feb 21, 2025 · 2 comments
Labels
doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem.

Comments

@gunters63
Copy link

gunters63 commented Feb 21, 2025 •
edited
Loading

Affected URL(s)

https://nodejs.org/docs/latest/api/http2.html#http2createsecureserveroptions-onrequesthandler

Description of the problem

The new options were added in Node 18.18.2, 20.8.1 und 21.0 to mitigate RST attacks.
It is documented for http2.createServer, but missing in http2.createSecureServer.

I am pretty sure it works for both, because the way createServer and createSecureServer share the code handling the options. It also makes absolutely no sense for them to work for createServer and not for createSecureServer.

The Typescript typings are also wrong. Only createServer typings recognizes streamResetBurst and streamResetRate. If I want to use them for createSecureServer, i have to supress typescript errors for this line and then it seems to work.
@gunters63 gunters63 added the doc Issues and PRs related to the documentations. label Feb 21, 2025
@jakecastelli jakecastelli added the http2 Issues or PRs related to the http2 subsystem. label Feb 24, 2025
@Sujal-Raj
Copy link
Contributor

Is this open to work on?

Sujal-Raj added a commit to Sujal-Raj/node that referenced this issue Feb 26, 2025
@Sujal-Raj
doc: add streamResetBurst and streamResetRate
afb5bea 
Added missing documentation for the streamResetBurst and streamResetRate
options in the http2.createSecureServer section. This ensures developers
are aware of these configurable options.

Fixes: nodejs#57169
Refs: https://nodejs.org/docs/latest/api/http2.html#http2createserveroptions-onrequesthandler
Sujal-Raj added a commit to Sujal-Raj/node that referenced this issue Feb 26, 2025
@Sujal-Raj
doc: add streamResetBurst and streamResetRate.
0b93798 
Added missing documentation for the streamResetBurst and streamResetRate options in the http2.createSecureServer section. This ensures developers are aware of these configurable options.
Fixes: nodejs#57169
Refs: https://nodejs.org/docs/latest/api/http2.html#http2createserveroptions-onrequesthandler
@gunters63
Copy link
Author

Note that this merge request did not resolve the wrong typings.

I guess I will create another bug for this.

@gunters63 gunters63 mentioned this issue Feb 26, 2025
Closed
aduh95 pushed a commit that referenced this issue Mar 9, 2025
@Sujal-Raj @aduh95
doc: add streamResetBurst and streamResetRate
83eed33 
Added missing documentation for the streamResetBurst and streamResetRate
options in the http2.createSecureServer section. This ensures developers
are aware of these configurable options.

Fixes: #57169
Refs: https://nodejs.org/docs/latest/api/http2.html#http2createserveroptions-onrequesthandler
PR-URL: #57195
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Tim Perry <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@gunters63 @jakecastelli @Sujal-Raj