Skip to content

Do not keep bailouted actions which might lead to reducer computing wrong value on update later #15198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 16 additions & 15 deletions packages/react-reconciler/src/ReactFiberHooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -1123,21 +1123,6 @@ function dispatchAction<S, A>(
next: null,
};

// Append the update to the end of the list.
const last = queue.last;
if (last === null) {
// This is the first update. Create a circular list.
update.next = update;
} else {
const first = last.next;
if (first !== null) {
// Still circular.
update.next = first;
}
last.next = update;
}
queue.last = update;

if (
fiber.expirationTime === NoWork &&
(alternate === null || alternate.expirationTime === NoWork)
Expand Down Expand Up @@ -1182,6 +1167,22 @@ function dispatchAction<S, A>(
warnIfNotCurrentlyBatchingInDev(fiber);
}
}

// Append the update to the end of the list.
const last = queue.last;
if (last === null) {
// This is the first update. Create a circular list.
update.next = update;
} else {
const first = last.next;
if (first !== null) {
// Still circular.
update.next = first;
}
last.next = update;
}
queue.last = update;

scheduleWork(fiber, expirationTime);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2071,4 +2071,103 @@ describe('ReactHooksWithNoopRenderer', () => {
expect(Scheduler).toFlushAndYield(['Step: 5, Shadow: 5']);
expect(ReactNoop).toMatchRenderedOutput('5');
});

it('successful eager bailout should not store dispatched item in the queue', () => {
let setDisabled;
let increment;

function Counter({disabled}) {
const [count, dispatch] = useReducer((state, action) => {
if (disabled) {
return state;
}
if (action.type === 'increment') {
return state + 1;
}
return state;
}, 0);

increment = () => dispatch({type: 'increment'});

Scheduler.yieldValue('Render count: ' + count);
return count;
}

function App() {
const [disabled, _setDisabled] = useState(true);
setDisabled = _setDisabled;
Scheduler.yieldValue('Render disabled: ' + disabled);
return <Counter disabled={disabled} />;
}

ReactNoop.render(<App />);
expect(Scheduler).toFlushAndYield([
'Render disabled: true',
'Render count: 0',
]);
expect(ReactNoop).toMatchRenderedOutput('0');

act(() => {
increment();
increment();
increment();
});
expect(Scheduler).toFlushAndYield([]);
expect(ReactNoop).toMatchRenderedOutput('0');

act(() => {
setDisabled(false);
});
expect(Scheduler).toFlushAndYield([
'Render disabled: false',
'Render count: 0',
]);
expect(ReactNoop).toMatchRenderedOutput('0');
});

it('eager bailout should get ignored in batch update when parent rerenders with new props', () => {
let setDisabled;
let increment;

function Counter({ disabled }) {
const [count, dispatch] = useReducer((state, action) => {
if (disabled) {
return state;
}
if (action.type === 'increment') {
return state + 1;
}
return state;
}, 0);

increment = () => dispatch({ type: 'increment' });

Scheduler.yieldValue('Render count: ' + count);
return count;
}

function App() {
const [disabled, _setDisabled] = useState(true);
setDisabled = _setDisabled;
Scheduler.yieldValue('Render disabled: ' + disabled);
return <Counter disabled={disabled} />;
}

ReactNoop.render(<App />);
expect(Scheduler).toFlushAndYield([
'Render disabled: true',
'Render count: 0',
]);
expect(ReactNoop).toMatchRenderedOutput('0');

act(() => {
increment();
setDisabled(false);
});
expect(Scheduler).toFlushAndYield([
'Render disabled: false',
'Render count: 1',
]);
expect(ReactNoop).toMatchRenderedOutput('1');
});
});