Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Fix indices of hooks in devtools when using useSyncExternalStore by blazejkustra · Pull Request #34547 · react/react · GitHub
Skip to content

Fix indices of hooks in devtools when using useSyncExternalStore - #34547

Merged
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch
Oct 21, 2025
Merged

Fix indices of hooks in devtools when using useSyncExternalStore#34547
hoxyq merged 4 commits into
react:mainfrom
blazejkustra:fix/devtools-hook-changed-mismatch

Conversation

@blazejkustra

@blazejkustrablazejkustra commented Sep 20, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR updates getChangedHooksIndices to account for the fact that useSyncExternalStore internally mounts two hooks, while DevTools should treat it as a single user-facing hook.

It introduces a helper isUseSyncExternalStoreHook to detect this case and adjust iteration so the extra internal hook is skipped when counting changes.

Before:

before.mov

After:

after.mov

How did you test this change?

I used this component to reproduce this issue locally (I followed instructions in packages/react-devtools/CONTRIBUTING.md).

functionTest(){// 1React.useSyncExternalStore(()=>{},()=>{},()=>{},);// 2const[state,setState]=useState('test');return(<><divonClick={()=>setState(Math.random())}style={{backgroundColor: 'red'}}>{state}</div></>);}

@blazejkustra
blazejkustra marked this pull request as ready for review September 22, 2025 17:38
@hoxyq
hoxyq self-requested a review October 15, 2025 02:39

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change makes sense, thank you for working on this.

Please address the comments that I've left, I think we can land this afterwards. Feel free to just tag me on all similar pull requests for other hooks, like useTransition(), useFormState(), useActionState().

}
}

index++;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you move this increment there?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By mistake, moving it back 👍

Comment on lines +1970 to +1973
if (next.next !== null) {
next = next.next;
prev = prev.next;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to check on next.next presence here, it should be implied if the hook object is actually an internal representation of useSyncExternalStore().

I would prefer it to crash instead, if this ever happens, so we spot the gap in our hook parsing logic first.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as well!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Back to you @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

As for the other hooks you mentioned, I'm interested in implementing it, though I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState. If you have any guidance, please let me know 😄

@hoxyq

Copy link
Copy Markdown
Collaborator

Thanks for updating the PR!

We have a feature that parses hook names, and I believe it is based on hooks indexes. I will double-check if this change actually breaks it, and will follow up here soon.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

I will double-check if this change actually breaks it, and will follow up here soon.

Just checking if you had a chance to look into this @hoxyq

@hoxyqhoxyq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, apologies for the delay.

For posterity, we don't use hooks indexes for hook names parsing. We just use the actual stack frame and then try to symbolicate it.

Also, we have 2 different implementations of fetching hook indexes:

  1. The first one lives in the renderer, which is used by the Profiler tab. This is the one that is updated in this PR.
  2. The second one lives in react-debug-tools/src/ReactDebugHooks.js, where we already correctly traverse the hook tree. This logic is used for displaying the "hooks" pane in the InspectedElement view.

useSyncExternalStore shim in react-debug-tools/src/ReactDebugHooks.js:
https://github.com/facebook/react/blob/ea0c17b0952e2b866a1f0dd4b5ac28c7df9d8518/packages/react-debug-tools/src/ReactDebugHooks.js#L462-L482

@hoxyq

Copy link
Copy Markdown
Collaborator

I'm unsure how to reliably identify (during traversal) if a hook is useTransition, useFormState, or useActionState

We don't store any identifiers on hooks, so I am not sure if there is a way to distinguish useTransition() from useState(); useCallback(). I will take a look once I have more time.

@hoxyq
hoxyq merged commit 39c6545 into react:mainOct 21, 2025
240 of 241 checks passed
@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Thanks for merging!! 🚀 (it's my first)

@blazejkustra

blazejkustra commented Oct 21, 2025

Copy link
Copy Markdown
ContributorAuthor

I am not sure if there is a way to distinguish useTransition() from useState(); useCallback()

After comparing these hooks, it does seem quite difficult to tell them apart 🤔

We don't store any identifiers on hooks

Could you discuss it with the team, maybe it's worth considering to add hook identifiers/type to each hook?

I created a draft PR for this, I think it should work but haven't tested it thoroughly. Let me know what do you think @hoxyq!

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

@hoxyq

hoxyq commented Nov 7, 2025

Copy link
Copy Markdown
Collaborator

Hey @hoxyq, just checking in. Any thoughts on the draft PR idea? 😄

That would make things easier for React DevTools, but at a cost of additional runtime / memory footprint of React, even in production.

There is a different way for React DevTools to override React's internals through dispatcher, which allows us to recreate the hook tree in a call order. This is what we are doing during component inspection on Components panel, but I believe we don't do it when recording a trace with Profiler panel. This should probably be the way.

@blazejkustra

Copy link
Copy Markdown
ContributorAuthor

Makes sense, I'll dig in this week 👍

@andreisilviudragnea

Copy link
Copy Markdown

Hello @blazejkustra@hoxyq I created a PR trying to fix this issue too back in September, but I got no response from React team: #34427

My solution tried to add multiple entries to the Component view for each internal hook node of a composite hook, so the index showed by "Hook X changed" returns correct values.

I am leaving this message here to consider this possible option for fixing the counter bug. As a new React dev who tried to learn React, this bug made everything way more complicated because I could not understand why the debugger was lying, so fixing this bug completely will help everyone, including newcomers like me.

andreisilviudragnea added a commit to andreisilviudragnea/react that referenced this pull request Dec 25, 2025
hoxyq added a commit that referenced this pull request Jan 15, 2026
## Summary
cc @hoxyqFixes#28584. Follow up to PR:
#34547
This PR updates getChangedHooksIndices to account for the fact that
`useSyncExternalStore`, `useTransition`, `useActionState`,
`useFormState` internally mounts more than one hook while DevTools
should treat it as a single user-facing hook.
Approach idea came from
[this](#34547 (comment))
comment 😄
Before:
https://github.com/user-attachments/assets/6bd5ce80-8b52-4bb8-8bb1-5e91b1e65043
After:
https://github.com/user-attachments/assets/47f56898-ab34-46b6-be7a-a54024dcefee
## How did you test this change?
I used this component to reproduce this issue locally (I followed
instructions in `packages/react-devtools/CONTRIBUTING.md`).
<details><summary>Details</summary>
```ts
import * as React from 'react';
function useDeepNestedHook() {
React.useState(0); // 1
return React.useState(1); // 2
}
function useNestedHook() {
const deepState = useDeepNestedHook();
React.useState(2); // 3
React.useState(3); // 4
return deepState;
}
// Create a simple store for useSyncExternalStore
function createStore(initialValue) {
let value = initialValue;
const listeners = new Set();
return {
getSnapshot: () => value,
subscribe: listener => {
listeners.add(listener);
return () => {
listeners.delete(listener);
};
},
update: newValue => {
value = newValue;
listeners.forEach(listener => listener());
},
};
}
const syncExternalStore = createStore(0);
export default function InspectableElements(): React.Node {
const [nestedState, setNestedState] = useNestedHook();
// 5
const syncExternalValue = React.useSyncExternalStore(
syncExternalStore.subscribe,
syncExternalStore.getSnapshot,
);
// 6
const [isPending, startTransition] = React.useTransition();
// 7
const [formState, formAction, formPending] = React.useActionState(
async (prevState, formData) => {
return {count: (prevState?.count || 0) + 1};
},
{count: 0},
);
const handleTransition = () => {
startTransition(() => {
setState(Math.random());
});
};
// 8
const [state, setState] = React.useState('test');
return (
<>
<div
style={{
padding: '20px',
display: 'flex',
flexDirection: 'column',
gap: '10px',
}}>
<div
onClick={() => setNestedState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {nestedState}
</div>
<button onClick={handleTransition} style={{padding: '10px'}}>
Trigger Transition {isPending ? '(pending...)' : ''}
</button>
<div style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
onClick={() => syncExternalStore.update(syncExternalValue + 1)}
style={{padding: '10px'}}>
Trigger useSyncExternalStore
</button>
<span>Value: {syncExternalValue}</span>
</div>
<form
action={formAction}
style={{display: 'flex', gap: '10px', alignItems: 'center'}}>
<button
type="submit"
style={{padding: '10px'}}
disabled={formPending}>
Trigger useFormState {formPending ? '(pending...)' : ''}
</button>
<span>Count: {formState.count}</span>
</form>
<div
onClick={() => setState(Math.random())}
style={{backgroundColor: 'red', padding: '10px', cursor: 'pointer'}}>
State: {state}
</div>
</div>
</>
);
}
```
</details>
---------
Co-authored-by: Ruslan Lesiutin <28902667+hoxyq@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@blazejkustra@hoxyq@andreisilviudragnea