Adding changelog for node compat improvements

[mikenomitch]

Adds Changelog for new Node APIs and docs for them

Summary

Adds a changelog for 3 additional node modules we now support and related docs.

Screenshots (optional)

[hyperlint-ai]

1 files reviewed, 2 total issue(s) found.

[vicb]

I think we should callout that the node:timers are "not interoperable" with the global timer functions because this behavior is different from Node.

We could also say "not fully interoperable" but we would then need to give details on what is vs what is not which could bring confusion.

For example (not sure we want to add this here):

import timers from 'node:timer';

// no-op, the timer is not cancelled
clearTimeout(timers.setTimeout(...));

// the timer is cancelled
timers.clearTimeout(setTimeout(...));

[anonrig]

I think we should callout that the node:timers are "not interoperable" with the global timer functions because this behavior is different from Node.

IMHO: This should be mentioned in nodejs docs about node:timers, not in cloudflare.

[vicb]

Well that is the exact issue here, this problem is specific to Cloudflare and does not exist on Node

[vicb]

That's why I think we should add a callout - we are not compatible with Node.js here.

[mikenomitch]

Do we have a thread on this generally? I'm not sure I fully understand what's going on here.

On the example provided, so in a Node.js environment the timer could be cancelled in the first example clearTimeout(timers.setTimeout(...)); but for us it is not cancelled?

If so, yeah I think that deserves a callout if behavior differs from Node.js.

Any other cases to mention?

[vicb]

On the example provided, so in a Node.js environment the timer could be cancelled in the first example clearTimeout(timers.setTimeout(...)); but for us it is not cancelled?

Your understanding is correct.

[anonrig]

setTimeout, setImmediate and setInterval doesn't return Timeout/Immediate classes on cloudflare because the web spec says that it should return an ID. Whereas, Node.js doesn't implement this. But this fact doesn't change with the new changes. We are not changing the existing behavior, we are just adding new modules. I don't think this changelog is the place to list every single differences that we have.

I recommend keeping this post as simple as possible, and just mention the behavior that we have added. IMHO: Other information should be mentioned in the documentation (not on changelog)

[mikenomitch]

Okay, I updated the node:timers docs to include a Note here. I didn't go super in depth though FWIW.

Kept out of the changelog since this changelog post is already super long and felt docs-y.

[vicb]

Oh... You probably got confused by the title of the PR (can it be updated?)
But we are now commenting on the documentation for the timers module, similar to https://developers.cloudflare.com/workers/runtime-apis/nodejs/process/

[mikenomitch]

Oh, no I gotcha - Just being overly clear on where I added it :)

[vicb]

Awesome work 🎉

It will be really helpful for our users!

Added some comment inline.

[cloudflare-workers-and-pages]

Deploying cloudflare-docs with    Cloudflare Pages

Latest commit:	b52cf38
Status:	✅  Deploy successful!
Preview URL:	https://68c49ea0.cloudflare-docs-7ou.pages.dev
Branch Preview URL:	https://mnomitch-node-changelog.cloudflare-docs-7ou.pages.dev

View logs

[github-actions]

Files with changes (up to 15)

Original Link	Updated Link
https://developers.cloudflare.com/workers/runtime-apis/nodejs/net/	https://mnomitch-node-changelog.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/nodejs/net/
https://developers.cloudflare.com/workers/runtime-apis/nodejs/timers/	https://mnomitch-node-changelog.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/nodejs/timers/
https://developers.cloudflare.com/workers/runtime-apis/nodejs/dns/	https://mnomitch-node-changelog.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/nodejs/dns/
https://developers.cloudflare.com/workers/runtime-apis/nodejs/assert/	https://mnomitch-node-changelog.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/nodejs/assert/
https://developers.cloudflare.com/workers/runtime-apis/nodejs/path/	https://mnomitch-node-changelog.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/nodejs/path/