Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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" + '
Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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('^' + ".*" + ' Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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('^' + ".*" + ' Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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" + ' Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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('^' + ".*" + ' Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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('^' + ".*" + ' Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading
, '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); } })(); })(); Improve the detection of changed hooks by blazejkustra · Pull Request #35123 · react/react · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/react-debug-tools/src/ReactDebugHooks.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -467,9 +467,11 @@ function useSyncExternalStore<T>(
// useSyncExternalStore() composes multiple hooks internally.
// Advance the current hook index the same number of times
// so that subsequent hooks have the right memoized state.
nextHook(); // SyncExternalStore
const hook = nextHook(); // SyncExternalStore
nextHook(); // Effect
const value = getSnapshot();
// Read from hook.memoizedState to get the value that was used during render,
// not the current value from getSnapshot() which may have changed.
const value = hook !== null ? hook.memoizedState : getSnapshot();
hookLog.push({
displayName: null,
primitive: 'SyncExternalStore',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -110,7 +110,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -125,7 +125,7 @@ describe('Profiler change descriptions', () => {
{
"context": false,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand All@@ -140,7 +140,7 @@ describe('Profiler change descriptions', () => {
{
"context": true,
"didHooksChange": false,
"hooks": null,
"hooks": [],
"isFirstMount": false,
"props": [],
"state": null,
Expand Down
249 changes: 246 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCache-test.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,12 @@ describe('ProfilingCache', () => {
),
);

// Save references to the real dispatch/setState functions.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite these variables with mock functions that do nothing.
const realDispatch = dispatch;
const realSetState = setState;

// Second render has no changed hooks, only changed props.
utils.act(() =>
render(
Expand All@@ -388,10 +394,10 @@ describe('ProfilingCache', () => {
);

// Third render has a changed reducer hook.
utils.act(() => dispatch({type: 'invert'}));
utils.act(() => realDispatch({type: 'invert'}));

// Fourth render has a changed state hook.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

// Fifth render has a changed context value, but no changed hook.
utils.act(() =>
Expand DownExpand Up@@ -521,6 +527,238 @@ describe('ProfilingCache', () => {
}
});

// @reactVersion >= 19.0
it('should detect what hooks changed in a render with custom and composite hooks', () => {
let snapshot = 0;
let syncExternalStoreCallback;

function subscribe(callback) {
syncExternalStoreCallback = callback;
return () => {};
}

function getSnapshot() {
return snapshot;
}

// Custom hook wrapping multiple primitive hooks
function useCustomHook() {
const [value, setValue] = React.useState('custom');
React.useEffect(() => {}, [value]);
return [value, setValue];
}

let setState = null;
let startTransition = null;
let actionStateDispatch = null;
let setCustomValue = null;
let setFinalState = null;

const Component = () => {
// Hook 0: useState
const [state, _setState] = React.useState('initial');
setState = _setState;

// Hook 1: useSyncExternalStore (composite hook - internally uses multiple hooks)
const storeValue = React.useSyncExternalStore(
subscribe,
getSnapshot,
getSnapshot,
);

// Hook 2: useTransition (composite hook - internally uses multiple hooks)
const [isPending, _startTransition] = React.useTransition();
startTransition = _startTransition;

// Hook 3: useActionState (composite hook - internally uses multiple hooks)
const [actionState, _actionStateDispatch] = React.useActionState(
(_prev, action) => action,
'action-initial',
);
actionStateDispatch = _actionStateDispatch;

// Hook 4: useState inside custom hook (flattened)
// Hook 5: useEffect inside custom hook (not stateful, won't show in changes)
const [customValue, _setCustomValue] = useCustomHook();
setCustomValue = _setCustomValue;

// Hook 6: direct useState at the end
const [finalState, _setFinalState] = React.useState('final');
setFinalState = _setFinalState;

return `${state}-${storeValue}-${isPending}-${actionState}-${customValue}-${finalState}`;
};

utils.act(() => store.profilerStore.startProfiling());
utils.act(() => render(<Component />));

// Save references before inspectHooks() overwrites them
const realSetState = setState;
const realStartTransition = startTransition;
const realActionStateDispatch = actionStateDispatch;
const realSetCustomValue = setCustomValue;
const realSetFinalState = setFinalState;

// 2nd render: change useState (hook 0)
utils.act(() => realSetState('changed'));

// 3rd render: change useSyncExternalStore (hook 1)
utils.act(() => {
snapshot = 1;
syncExternalStoreCallback();
});

// 4th render: trigger useTransition (hook 2)
// Note: useTransition triggers two renders - one when isPending becomes true,
// and another when isPending becomes false after the transition completes
utils.act(() => {
realStartTransition(() => {});
});

// 6th render: change useActionState (hook 3)
utils.act(() => realActionStateDispatch('action-changed'));

// 7th render: change custom hook's useState (hook 4)
utils.act(() => realSetCustomValue('custom-changed'));

// 8th render: change final useState (hook 6)
utils.act(() => realSetFinalState('final-changed'));

utils.act(() => store.profilerStore.stopProfiling());

const rootID = store.roots[0];

const changeDescriptions = store.profilerStore
.getDataForRoot(rootID)
.commitData.map(commitData => commitData.changeDescriptions);
expect(changeDescriptions).toHaveLength(8);

// 1st render: Initial mount
expect(changeDescriptions[0]).toMatchInlineSnapshot(`
Map {
2 => {
"context": null,
"didHooksChange": false,
"isFirstMount": true,
"props": null,
"state": null,
},
}
`);

// 2nd render: Changed hook 0 (useState)
expect(changeDescriptions[1]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
0,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 3rd render: Changed hook 1 (useSyncExternalStore)
expect(changeDescriptions[2]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
1,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 4th render: Changed hook 2 (useTransition - isPending becomes true)
expect(changeDescriptions[3]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 5th render: Changed hook 2 (useTransition - isPending becomes false)
expect(changeDescriptions[4]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
2,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 6th render: Changed hook 3 (useActionState)
expect(changeDescriptions[5]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
3,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 7th render: Changed hook 4 (useState inside useCustomHook)
expect(changeDescriptions[6]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
4,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);

// 8th render: Changed hook 6 (final useState)
expect(changeDescriptions[7]).toMatchInlineSnapshot(`
Map {
2 => {
"context": false,
"didHooksChange": true,
"hooks": [
6,
],
"isFirstMount": false,
"props": [],
"state": null,
},
}
`);
});

// @reactVersion >= 19.0
it('should detect context changes or lack of changes with conditional use()', () => {
const ContextA = React.createContext(0);
Expand DownExpand Up@@ -553,6 +791,11 @@ describe('ProfilingCache', () => {
),
);

// Save reference to the real setState function before profiling starts.
// inspectHooks() re-runs the component with a mock dispatcher,
// which would overwrite setState with a mock function that does nothing.
const realSetState = setState;

utils.act(() => store.profilerStore.startProfiling());

// First render changes Context.
Expand All@@ -567,7 +810,7 @@ describe('ProfilingCache', () => {
);

// Second render has no changed Context, only changed state.
utils.act(() => setState('def'));
utils.act(() => realSetState('def'));

utils.act(() => store.profilerStore.stopProfiling());

Expand Down
Loading
Loading