-
Notifications
You must be signed in to change notification settings - Fork 30.4k
fix: add useEffectEvent to disallowed server APIs #88950
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.
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
Conversation
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
timneutkens
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are other lists, for example this one would also need it:
| "useEffect", |
timneutkens
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You'll want to search for all cases of a similar list existing because there's more than just these two.
|
@timneutkens |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CodSpeed Performance ReportMerging this PR will not alter performanceComparing Summary
Footnotes
|
…ponents (#88985) <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> ### What? Add `useEffectEvent` to the list of invalid React APIs in Server Components. ### Why? Using `useEffectEvent` in a Server Component results in a **runtime error**: TypeError: (0 , react_1.useEffectEvent) is not a function. Without this fix, developers only discover the mistake at runtime. This change improves the **Developer Experience (DX) by catching the error immediately in the IDE.** #### Expected Behavior <img width="999" height="566" alt="image" src="https://github.com/user-attachments/assets/79c1cbf9-ae0e-4ad7-b163-f650fb289a3a" /> #### Currently <img width="1708" height="805" alt="image" src="https://github.com/user-attachments/assets/a33f73e5-24fd-4405-826a-53f1810154a7" /> <img width="2091" height="812" alt="image" src="https://github.com/user-attachments/assets/ed3f191e-a34d-42dd-8779-1d524f6f035d" /> ### How? - Added `useEffectEvent` to Rust RSC transform (`react_server_components.rs`) - Added `useEffectEvent` to TypeScript constants (`constant.ts`) - Added `useEffectEvent` to error formatting (`format-server-error.ts`) - Added test fixture and updated test file ## Note This is a reapply of the previous [PR](#88950). With help from @timneutkens, I all previously worked code to ensure nothing was missed before resubmitting. Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
What?
Add
useEffectEventto theDISALLOWED_SERVER_REACT_APISlist in the Next.js to prevent its usage in Server Components.Disallowed: useState, useEffect, useLayoutEffect (correctly blocked with a error)
Allowed (Incorrectly): useEffectEvent (but causes a runtime crash)
This PR ensures
useEffectEventis correctly identified as a client-only API, providing the same level of validation as other restricted Hooks.Why?
Using
useEffectEventin a Server Component results in a runtime error:TypeError: (0 , react_1.useEffectEvent) is not a function.Without this fix, developers only discover the mistake at runtime. This change improves the Developer Experience (DX) by catching the error immediately in the IDE.
How?
Added
useEffectEventinDISALLOWED_SERVER_REACT_APIS