-
Notifications
You must be signed in to change notification settings - Fork 1.4k
fix(useId): prevent FinalizationRegistry entry leak in useId #9853
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
Open
reidbarber
wants to merge
3
commits into
main
Choose a base branch
from
fix-useid-leak
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−2
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| describe('useId', function () { | ||
| let OriginalFinalizationRegistry = global.FinalizationRegistry; | ||
|
|
||
| afterEach(() => { | ||
| global.FinalizationRegistry = OriginalFinalizationRegistry; | ||
| jest.resetModules(); | ||
| }); | ||
|
|
||
| it('registers once per mounted id and uses an unregister token', function () { | ||
| let register = jest.fn(); | ||
| let unregister = jest.fn(); | ||
|
|
||
| global.FinalizationRegistry = jest.fn(function () { | ||
| this.register = register; | ||
| this.unregister = unregister; | ||
| }); | ||
|
|
||
| jest.isolateModules(() => { | ||
| let React = require('react'); | ||
| let ReactDOM = require('react-dom'); | ||
| let {act} = require('react-dom/test-utils'); | ||
| let {useId} = require('../../src/utils/useId'); | ||
| let isReact18OrHigher = parseInt(React.version, 10) >= 18; | ||
|
|
||
| function Test({tick}) { | ||
| let id = useId(); | ||
| return React.createElement('div', {'data-id': id}, tick); | ||
| } | ||
|
|
||
| let container = document.createElement('div'); | ||
| document.body.appendChild(container); | ||
|
|
||
| // Use createRoot for React 18+ and ReactDOM.render for older | ||
| let renderElement; | ||
| let unmount; | ||
| if (isReact18OrHigher) { | ||
| let {createRoot} = require('react-dom/client'); | ||
| global.IS_REACT_ACT_ENVIRONMENT = true; | ||
| let root = createRoot(container); | ||
| renderElement = (el) => root.render(el); | ||
| unmount = () => root.unmount(); | ||
| } else { | ||
| renderElement = (el) => ReactDOM.render(el, container); | ||
| unmount = () => ReactDOM.unmountComponentAtNode(container); | ||
| } | ||
|
|
||
| act(() => { | ||
| renderElement(React.createElement(Test, {tick: 0})); | ||
| }); | ||
|
|
||
| act(() => { | ||
| renderElement(React.createElement(Test, {tick: 1})); | ||
| }); | ||
|
|
||
| act(() => { | ||
| renderElement(React.createElement(Test, {tick: 2})); | ||
| }); | ||
|
|
||
| // Re-rendering the same mounted hook should not add more registry entries. | ||
| expect(register).toHaveBeenCalledTimes(1); | ||
| // The held value should be the generated id string, and the unregister token should match | ||
| // the target object so useId can remove the same registration during cleanup. | ||
| expect(register.mock.calls[0][1]).toEqual(expect.any(String)); | ||
| expect(register.mock.calls[0][2]).toBe(register.mock.calls[0][0]); | ||
reidbarber marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| act(() => { | ||
| unmount(); | ||
| }); | ||
|
|
||
| document.body.removeChild(container); | ||
|
|
||
| // Unmount should remove the specific registration created for this hook instance. | ||
| expect(unregister).toHaveBeenCalledTimes(1); | ||
| expect(unregister).toHaveBeenCalledWith(register.mock.calls[0][2]); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.