docs: Update Client Requirements template for 3.0 release - #27802
docs: Update Client Requirements template for 3.0 release#27802Josmithr wants to merge 1 commit into
Conversation
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (14 lines, 1 files), I've queued these reviewers:
How this works
|
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Bundle size comparisonBase commit: The PR's CI build failed — fix the build and the comment will update once the next run succeeds. |
jason-ha
left a comment
There was a problem hiding this comment.
I wonder if we should call out Jest+require-ESM issue in here.
NodeJS supports require-ESM fully as of 22.12.
Jest want's NodeJS 24.9 or later.
| Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here. | ||
|
|
||
| - Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648)) | ||
| CommonJs is no longer officially supported as of version 3.0. |
There was a problem hiding this comment.
We might want to explicitly support require(ESM) (see https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require ) and ensure our ESM modules are compatible with that (in our case that mainly means avoiding top level await, which we currently do not use).
| CommonJs is no longer officially supported as of version 3.0. | |
| We no longer publish CommonJs modules as of 3.0, however we do support loading our ES Modules from CommonJs using [require(ESM)](https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require) which is supported in NodeJS `>=22.12.0`. |
| @@ -14,10 +14,11 @@ When making such a request please include if the configuration already works (an | |||
|
|
|||
There was a problem hiding this comment.
The above statement about NodeJS version implies we currently support Node 22 and node 24 (since node 22 is less than a year from EOL).
That's fine I guess, but we might want to adjust the phrasing to just say we support Node22 and Node24 as long as they are not EOL, or something like that.
| @@ -14,10 +14,11 @@ When making such a request please include if the configuration already works (an | |||
|
|
|||
There was a problem hiding this comment.
Is the:
- Running Fluid in a Node.js environment with the
--no-experimental-fetchflag is not supported.
line above still relevant? Perhaps we can remove it?
Updates the Client Requirements template with updates for 3.0. This content is embedded in the majority of our library package READMEs.
Note
This won't be merged until we are ready to begin checking in breaking changes for 3.0.
AB#78964