doc: add note regarding net.Socket default timeout

[aduh95]

Adding a note stating the difference between default timeout on http[2s] servers and on net.Socket.

Should be backported to v10 as well.

Fixes: #31378
Fixes: #27556
Refs: #27704

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• documentation is changed or added
• commit message follows commit guidelines

[mscdex]

This should also be added to master for consistency.

[mscdex]

Also, this kind of note should probably be moved to each of the separate, relevant (http/https/http2) module documentations for better visibility.

[MylesBorins]

Reviewing this it seems like perhaps this should target master and then get backported to 12.x.

If it is relevant to master we really shouldn't start with targeting LTS

[aduh95]

Also, this kind of note should probably be moved to each of the separate, relevant (http/https/http2) module documentations for better visibility.

To me, docs there are already specific enough regarding the default timeout value, what are the changes you suggest @mscdex?

[mscdex]

@aduh95 I meant the change in default timeout should be noted in the documentation for each appropriate subsystem, most likely listed in the changes: YAML somewhere. The reason I believe this change shouldn't be made in the net documentation is that I don't think most people using the http* modules are going to know to find these details in the documentation for net.

[Trott]

Can we incorporate this information into the YAML matter instead of having it here?

[Trott]

Can we incorporate this information into the YAML matter instead of having it here?

Oh, wait, no, not that YAML matter. What's the rationale for putting this in net instead of http, https, and http2 docs?

[aduh95]

Apparently some users are referring to net docs when working with http.Server (see #31378); prior to Node.js 13, default values are consistent across all sockets in Node.js codebase EXCEPT for the timeout, I figured adding a note would help avoid the confusion.
Users who refer to http[s2] docs already have the correct information, I'm not sure there is much confusion from that side.

[Trott]

Also, this kind of note should probably be moved to each of the separate, relevant (http/https/http2) module documentations for better visibility.

To me, docs there are already specific enough regarding the default timeout value, what are the changes you suggest @mscdex?

In that case, can we just leave it out here?

[addaleax]

Making it explicit that this should not land as-is for the reasons given by the others:

• This should not go into the net docs
• This should be presented as YAML metadata.

[aduh95]

I’m going to close this, docs on http* modules provide the correct information, I haven’t seen any report (except #31378) of a confusion on that area of the docs, and the default timeout thing doesn’t exist anymore as of Node.js 13. All in all, I don’t think it’s worth it, if someone feels differently, you’re welcome to open another PR.

We could also close the linked issues maybe.