You Might Not Need an Effect
Effects are an escape hatch from the React paradigm. They let you âstep outsideâ of React and synchronize your components with some external system like a non-React widget, network, or the browser DOM. If there is no external system involved (for example, if you want to update a componentâs state when some props or state change), you shouldnât need an Effect. Removing unnecessary Effects will make your code easier to follow, faster to run, and less error-prone.
You will learn
- Why and how to remove unnecessary Effects from your components
- How to cache expensive computations without Effects
- How to reset and adjust component state without Effects
- How to share logic between event handlers
- Which logic should be moved to event handlers
- How to notify parent components about changes
How to remove unnecessary Effects
There are two common cases in which you donât need Effects:
- You donât need Effects to transform data for rendering. For example, letâs say you want to filter a list before displaying it. You might feel tempted to write an Effect that updates a state variable when the list changes. However, this is inefficient. When you update your componentâs state, React will first call your component functions to calculate what should be on the screen. Then React will âcommitâ these changes to the DOM, updating the screen. Then React will run your Effects. If your Effect also immediately updates the state, this restarts the whole process from scratch! To avoid the unnecessary render passes, transform all the data at the top level of your components. That code will automatically re-run whenever your props or state change.
- You donât need Effects to handle user events. For example, letâs say you want to send an
/api/buy
POST request and show a notification when the user buys a product. In the Buy button click event handler, you know exactly what happened. By the time an Effect runs, you donât know what the user did (for example, which button was clicked). This is why youâll usually handle user events in the corresponding event handlers.
You do need Effects to synchronize with external systems. For example, you can write an Effect that keeps a jQuery widget synchronized with the React state. You can also fetch data with Effects: for example, you can synchronize the search results with the current search query. Keep in mind that modern frameworks provide more efficient built-in data fetching mechanisms than writing Effects directly in your components.
To help you gain the right intuition, letâs look at some common concrete examples!
Updating state based on props or state
Suppose you have a component with two state variables: firstName
and lastName
. You want to calculate a fullName
from them by concatenating them. Moreover, youâd like fullName
to update whenever firstName
or lastName
change. Your first instinct might be to add a fullName
state variable and update it in an Effect:
function Form() {
const [firstName, setFirstName] = useState('Taylor');
const [lastName, setLastName] = useState('Swift');
// đ´ Avoid: redundant state and unnecessary Effect
const [fullName, setFullName] = useState('');
useEffect(() => {
setFullName(firstName + ' ' + lastName);
}, [firstName, lastName]);
// ...
}
This is more complicated than necessary. It is inefficient too: it does an entire render pass with a stale value for fullName
, then immediately re-renders with the updated value. Remove both the state variable and the Effect:
function Form() {
const [firstName, setFirstName] = useState('Taylor');
const [lastName, setLastName] = useState('Swift');
// â
Good: calculated during rendering
const fullName = firstName + ' ' + lastName;
// ...
}
When something can be calculated from the existing props or state, donât put it in state. Instead, calculate it during rendering. This makes your code faster (you avoid the extra âcascadingâ updates), simpler (you remove some code), and less error-prone (you avoid bugs caused by different state variables getting out of sync with each other). If this approach feels new to you, Thinking in React has some guidance on what should go into state.
Caching expensive calculations
This component computes visibleTodos
by taking the todos
it receives by props and filtering them according to the filter
prop. You might feel tempted to store the result in a state variable and update it in an Effect:
function TodoList({ todos, filter }) {
const [newTodo, setNewTodo] = useState('');
// đ´ Avoid: redundant state and unnecessary Effect
const [visibleTodos, setVisibleTodos] = useState([]);
useEffect(() => {
setVisibleTodos(getFilteredTodos(todos, filter));
}, [todos, filter]);
// ...
}
Like in the earlier example, this is both unnecessary and inefficient. First, remove the state and the Effect:
function TodoList({ todos, filter }) {
const [newTodo, setNewTodo] = useState('');
// â
This is fine if getFilteredTodos() is not slow.
const visibleTodos = getFilteredTodos(todos, filter);
// ...
}
In many cases, this code is fine! But maybe getFilteredTodos()
is slow or you have a lot of todos
. In that case you donât want to recalculate getFilteredTodos()
if some unrelated state variable like newTodo
has changed.
You can cache (or âmemoizeâ) an expensive calculation by wrapping it in a useMemo
Hook:
import { useMemo, useState } from 'react';
function TodoList({ todos, filter }) {
const [newTodo, setNewTodo] = useState('');
const visibleTodos = useMemo(() => {
// â
Does not re-run unless todos or filter change
return getFilteredTodos(todos, filter);
}, [todos, filter]);
// ...
}
Or, written as a single line:
import { useMemo, useState } from 'react';
function TodoList({ todos, filter }) {
const [newTodo, setNewTodo] = useState('');
// â
Does not re-run getFilteredTodos() unless todos or filter change
const visibleTodos = useMemo(() => getFilteredTodos(todos, filter), [todos, filter]);
// ...
}
This tells React that you donât want the inner function to re-run unless either todos
or filter
have changed. React will remember the return value of getFilteredTodos()
during the initial render. During the next renders, it will check if todos
or filter
are different. If theyâre the same as last time, useMemo
will return the last result it has stored. But if they are different, React will call the wrapped function again (and store that result instead).
The function you wrap in useMemo
runs during rendering, so this only works for pure calculations.
Deep Dive
How to tell if a calculation is expensive?
How to tell if a calculation is expensive?
In general, unless youâre creating or looping over thousands of objects, itâs probably not expensive. If you want to get more confidence, you can add a console log to measure the time spent in a piece of code:
console.time('filter array');
const visibleTodos = getFilteredTodos(todos, filter);
console.timeEnd('filter array');
Perform the interaction youâre measuring (for example, typing into the input). You will then see logs like filter array: 0.15ms
in your console. If the overall logged time adds up to a significant amount (say, 1ms
or more), it might make sense to memoize that calculation. As an experiment, you can then wrap the calculation in useMemo
to verify whether the total logged time has decreased for that interaction or not:
console.time('filter array');
const visibleTodos = useMemo(() => {
return getFilteredTodos(todos, filter); // Skipped if todos and filter haven't changed
}, [todos, filter]);
console.timeEnd('filter array');
useMemo
wonât make the first render faster. It only helps you skip unnecessary work on updates.
Keep in mind that your machine is probably faster than your usersâ so itâs a good idea to test the performance with an artificial slowdown. For example, Chrome offers a CPU Throttling option for this.
Also note that measuring performance in development will not give you the most accurate results. (For example, when Strict Mode is on, you will see each component render twice rather than once.) To get the most accurate timings, build your app for production and test it on a device like your users have.
Resetting all state when a prop changes
This ProfilePage
component receives a userId
prop. The page contains a comment input, and you use a comment
state variable to hold its value. One day, you notice a problem: when you navigate from one profile to another, the comment
state does not get reset. As a result, itâs easy to accidentally post a comment on a wrong userâs profile. To fix the issue, you want to clear out the comment
state variable whenever the userId
changes:
export default function ProfilePage({ userId }) {
const [comment, setComment] = useState('');
// đ´ Avoid: Resetting state on prop change in an Effect
useEffect(() => {
setComment('');
}, [userId]);
// ...
}
This is inefficient because ProfilePage
and its children will first render with the stale value, and then render again. It is also complicated because youâd need to do this in every component that has some state inside ProfilePage
. For example, if the comment UI is nested, youâd want to clear out nested comment state too.
Instead, you can tell React that each userâs profile is conceptually a different profile by giving it an explicit key. Split your component in two and pass a key
attribute from the outer component to the inner one:
export default function ProfilePage({ userId }) {
return (
<Profile
userId={userId}
key={userId}
/>
);
}
function Profile({ userId }) {
// â
This and any other state below will reset on key change automatically
const [comment, setComment] = useState('');
// ...
}
Normally, React preserves the state when the same component is rendered in the same spot. By passing userId
as a key
to the Profile
component, youâre asking React to treat two Profile
components with different userId
as two different components that should not share any state. Whenever the key (which youâve set to userId
) changes, React will recreate the DOM and reset the state of the Profile
component and all of its children. As a result, the comment
field will clear out automatically when navigating between profiles.
Note that in this example, only the outer ProfilePage
component is exported and visible to other files in the project. Components rendering ProfilePage
donât need to pass the key to it: they pass userId
as a regular prop. The fact ProfilePage
passes it as a key
to the inner Profile
component is an implementation detail.
Adjusting some state when a prop changes
Sometimes, you might want to reset or adjust a part of the state on a prop change, but not all of it.
This List
component receives a list of items
as a prop, and maintains the selected item in the selection
state variable. You want to reset the selection
to null
whenever the items
prop receives a different array:
function List({ items }) {
const [isReverse, setIsReverse] = useState(false);
const [selection, setSelection] = useState(null);
// đ´ Avoid: Adjusting state on prop change in an Effect
useEffect(() => {
setSelection(null);
}, [items]);
// ...
}
This, too, is not ideal. Every time the items
change, the List
and its child components will render with a stale selection
value at first. Then React will update the DOM and run the Effects. Finally, the setSelection(null)
call will cause another re-render of the List
and its child components, restarting this whole process again.
Start by deleting the Effect. Instead, adjust the state directly during rendering:
function List({ items }) {
const [isReverse, setIsReverse] = useState(false);
const [selection, setSelection] = useState(null);
// Better: Adjust the state while rendering
const [prevItems, setPrevItems] = useState(items);
if (items !== prevItems) {
setPrevItems(items);
setSelection(null);
}
// ...
}
Storing information from previous renders like this can be hard to understand, but itâs better than updating the same state in an Effect. In the above example, setSelection
is called directly during a render. React will re-render the List
immediately after it exits with a return
statement. By that point, React hasnât rendered the List
children or updated the DOM yet, so this lets the List
children skip rendering the stale selection
value.
When you update a component during rendering, React throws away the returned JSX and immediately retries rendering. To avoid very slow cascading retries, React only lets you update the same componentâs state during a render. If you update another componentâs state during a render, youâll see an error. A condition like items !== prevItems
is necessary to avoid loops. You may adjust state like this, but any other side effects (like changing the DOM or setting a timeout) should remain in event handlers or Effects to keep your components predictable.
Although this pattern is more efficient than an Effect, most components shouldnât need it either. No matter how you do it, adjusting state based on props or other state makes your data flow more difficult to understand and debug. Always check whether you can reset all state with a key or calculate everything during rendering instead. For example, instead of storing (and resetting) the selected item, you can store the selected item ID:
function List({ items }) {
const [isReverse, setIsReverse] = useState(false);
const [selectedId, setSelectedId] = useState(null);
// â
Best: Calculate everything during rendering
const selection = items.find(item => item.id === selectedId) ?? null;
// ...
}
Now there is no need to âadjustâ the state at all. If the item with the selected ID is in the list, it remains selected. If itâs not, the selection
calculated during rendering will be null
because no matching item was found. This behavior is a bit different, but arguably itâs better because most changes to items
now preserve the selection. However, youâd need to use selection
in all the logic below because an item with selectedId
might not exist.
Sharing logic between event handlers
Letâs say you have a product page with two buttons (Buy and Checkout) that both let you buy that product. You want to show a notification whenever the user puts the product in the cart. Adding the showNotification()
call to both buttonsâ click handlers feels repetitive so you might be tempted to place this logic in an Effect:
function ProductPage({ product, addToCart }) {
// đ´ Avoid: Event-specific logic inside an Effect
useEffect(() => {
if (product.isInCart) {
showNotification(`Added ${product.name} to the shopping cart!`);
}
}, [product]);
function handleBuyClick() {
addToCart(product);
}
function handleCheckoutClick() {
addToCart(product);
navigateTo('/checkout');
}
// ...
}
This Effect is unnecessary. It will also most likely cause bugs. For example, letâs say that your app âremembersâ the shopping cart between the page reloads. If you add a product to the cart once and refresh the page, the notification will appear again. It will keep appearing every time you refresh that productâs page. This is because product.isInCart
will already be true
on the page load, so the Effect above will call showNotification()
.
When youâre not sure whether some code should be in an Effect or in an event handler, ask yourself why this code needs to run. Use Effects only for code that should run because the component was displayed to the user. In this example, the notification should appear because the user pressed the button, not because the page was displayed! Delete the Effect and put the shared logic into a function that you call from both event handlers:
function ProductPage({ product, addToCart }) {
// â
Good: Event-specific logic is called from event handlers
function buyProduct() {
addToCart(product);
showNotification(`Added ${product.name} to the shopping cart!`);
}
function handleBuyClick() {
buyProduct();
}
function handleCheckoutClick() {
buyProduct();
navigateTo('/checkout');
}
// ...
}
This both removes the unnecessary Effect and fixes the bug.
Sending a POST request
This Form
component sends two kinds of POST requests. It sends an analytics event when it mounts. When you fill in the form and click the Submit button, it will send a POST request to the /api/register
endpoint:
function Form() {
const [firstName, setFirstName] = useState('');
const [lastName, setLastName] = useState('');
// â
Good: This logic should run because the component was displayed
useEffect(() => {
post('/analytics/event', { eventName: 'visit_form' });
}, []);
// đ´ Avoid: Event-specific logic inside an Effect
const [jsonToSubmit, setJsonToSubmit] = useState(null);
useEffect(() => {
if (jsonToSubmit !== null) {
post('/api/register', jsonToSubmit);
}
}, [jsonToSubmit]);
function handleSubmit(e) {
e.preventDefault();
setJsonToSubmit({ firstName, lastName });
}
// ...
}
Letâs apply the same criteria as in the example before.
The analytics POST request should remain in an Effect. This is because the reason to send the analytics event is that the form was displayed. (It would fire twice in development, but see here for how to deal with that.)
However, the /api/register
POST request is not caused by the form being displayed. You only want to send the request at one specific moment in time: when the user presses the button. It should only ever happen on that particular interaction. Delete the second Effect and move that POST request into the event handler:
function Form() {
const [firstName, setFirstName] = useState('');
const [lastName, setLastName] = useState('');
// â
Good: This logic runs because the component was displayed
useEffect(() => {
post('/analytics/event', { eventName: 'visit_form' });
}, []);
function handleSubmit(e) {
e.preventDefault();
// â
Good: Event-specific logic is in the event handler
post('/api/register', { firstName, lastName });
}
// ...
}
When you choose whether to put some logic into an event handler or an Effect, the main question you need to answer is what kind of logic it is from the userâs perspective. If this logic is caused by a particular interaction, keep it in the event handler. If itâs caused by the user seeing the component on the screen, keep it in the Effect.
Chains of computations
Sometimes you might feel tempted to chain Effects that each adjust a piece of state based on other state:
function Game() {
const [card, setCard] = useState(null);
const [goldCardCount, setGoldCardCount] = useState(0);
const [round, setRound] = useState(1);
const [isGameOver, setIsGameOver] = useState(false);
// đ´ Avoid: Chains of Effects that adjust the state solely to trigger each other
useEffect(() => {
if (card !== null && card.gold) {
setGoldCardCount(c => c + 1);
}
}, [card]);
useEffect(() => {
if (goldCardCount > 3) {
setRound(r => r + 1)
setGoldCardCount(0);
}
}, [goldCardCount]);
useEffect(() => {
if (round > 5) {
setIsGameOver(true);
}
}, [round]);
useEffect(() => {
alert('Good game!');
}, [isGameOver]);
function handlePlaceCard(nextCard) {
if (isGameOver) {
throw Error('Game already ended.');
} else {
setCard(nextCard);
}
}
// ...
There are two problems with this code.
One problem is that it is very inefficient: the component (and its children) have to re-render between each set
call in the chain. In the example above, in the worst case (setCard
â render â setGoldCardCount
â render â setRound
â render â setIsGameOver
â render) there are three unnecessary re-renders of the tree below.
Even if it werenât slow, as your code evolves, you will run into cases where the âchainâ you wrote doesnât fit the new requirements. Imagine you are adding a way to step through the history of the game moves. Youâd do it by updating each state variable to a value from the past. However, setting the card
state to a value from the past would trigger the Effect chain again and change the data youâre showing. Code like this is often rigid and fragile.
In this case, itâs better to calculate what you can during rendering, and adjust the state in the event handler:
function Game() {
const [card, setCard] = useState(null);
const [goldCardCount, setGoldCardCount] = useState(0);
const [round, setRound] = useState(1);
// â
Calculate what you can during rendering
const isGameOver = round > 5;
function handlePlaceCard(nextCard) {
if (isGameOver) {
throw Error('Game already ended.');
}
// â
Calculate all the next state in the event handler
setCard(nextCard);
if (nextCard.gold) {
if (goldCardCount <= 3) {
setGoldCardCount(goldCardCount + 1);
} else {
setGoldCardCount(0);
setRound(round + 1);
if (round === 5) {
alert('Good game!');
}
}
}
}
// ...
This is a lot more efficient. Also, if you implement a way to view game history, now you will be able to set each state variable to a move from the past without triggering the Effect chain that adjusts every other value. If you need to reuse logic between several event handlers, you can extract a function and call it from those handlers.
Remember that inside event handlers, state behaves like a snapshot. For example, even after you call setRound(round + 1)
, the round
variable will reflect the value at the time the user clicked the button. If you need to use the next value for calculations, define it manually like const nextRound = round + 1
.
In some cases, you canât calculate the next state directly in the event handler. For example, imagine a form with multiple dropdowns where the options of the next dropdown depend on the selected value of the previous dropdown. Then, a chain of Effects fetching data is appropriate because you are synchronizing with network.
Initializing the application
Some logic should only run once when the app loads. You might place it in an Effect in the top-level component:
function App() {
// đ´ Avoid: Effects with logic that should only ever run once
useEffect(() => {
loadDataFromLocalStorage();
checkAuthToken();
}, []);
// ...
}
However, youâll quickly discover that it runs twice in development. This can cause issuesâfor example, maybe it invalidates the authentication token because the function wasnât designed to be called twice. In general, your components should be resilient to being remounted. This includes your top-level App
component. Although it may not ever get remounted in practice in production, following the same constraints in all components makes it easier to move and reuse code. If some logic must run once per app load rather than once per component mount, you can add a top-level variable to track whether it has already executed, and always skip re-running it:
let didInit = false;
function App() {
useEffect(() => {
if (!didInit) {
didInit = true;
// â
Only runs once per app load
loadDataFromLocalStorage();
checkAuthToken();
}
}, []);
// ...
}
You can also run it during module initialization and before the app renders:
if (typeof window !== 'undefined') { // Check if we're running in the browser.
// â
Only runs once per app load
checkAuthToken();
loadDataFromLocalStorage();
}
function App() {
// ...
}
Code at the top level runs once when your component is importedâeven if it doesnât end up being rendered. To avoid slowdown or surprising behavior when importing arbitrary components, donât overuse this pattern. Keep app-wide initialization logic to root component modules like App.js
or in your applicationâs entry point module.
Notifying parent components about state changes
Letâs say youâre writing a Toggle
component with an internal isOn
state which can be either true
or false
. There are a few different ways to toggle it (by clicking or dragging). You want to notify the parent component whenever the Toggle
internal state changes, so you expose an onChange
event and call it from an Effect:
function Toggle({ onChange }) {
const [isOn, setIsOn] = useState(false);
// đ´ Avoid: The onChange handler runs too late
useEffect(() => {
onChange(isOn);
}, [isOn, onChange])
function handleClick() {
setIsOn(!isOn);
}
function handleDragEnd(e) {
if (isCloserToRightEdge(e)) {
setIsOn(true);
} else {
setIsOn(false);
}
}
// ...
}
Like earlier, this is not ideal. The Toggle
updates its state first, and React updates the screen. Then React runs the Effect, which calls the onChange
function passed from a parent component. Now the parent component will update its own state, starting another render pass. It would be better to do everything in a single pass instead.
Delete the Effect and instead update the state of both components within the same event handler:
function Toggle({ onChange }) {
const [isOn, setIsOn] = useState(false);
function updateToggle(nextIsOn) {
// â
Good: Perform all updates during the event that caused them
setIsOn(nextIsOn);
onChange(nextIsOn);
}
function handleClick() {
updateToggle(!isOn);
}
function handleDragEnd(e) {
if (isCloserToRightEdge(e)) {
updateToggle(true);
} else {
updateToggle(false);
}
}
// ...
}
With this approach, both the Toggle
component and its parent component update their state during the event. React batches updates from different components together, so there will only be one render pass as a result.
You might also be able to remove the state altogether, and instead receive isOn
from the parent component:
// â
Also good: the component is fully controlled by its parent
function Toggle({ isOn, onChange }) {
function handleClick() {
onChange(!isOn);
}
function handleDragEnd(e) {
if (isCloserToRightEdge(e)) {
onChange(true);
} else {
onChange(false);
}
}
// ...
}
âLifting state upâ lets the parent component fully control the Toggle
by toggling the parentâs own state. This means the parent component will have to contain more logic, but there will be less state overall to worry about. Whenever you try to keep two different state variables synchronized, itâs a sign to try lifting state up instead!
Passing data to the parent
This Child
component fetches some data and then passes it to the Parent
component in an Effect:
function Parent() {
const [data, setData] = useState(null);
// ...
return <Child onFetched={setData} />;
}
function Child({ onFetched }) {
const data = useSomeAPI();
// đ´ Avoid: Passing data to the parent in an Effect
useEffect(() => {
if (data) {
onFetched(data);
}
}, [onFetched, data]);
// ...
}
In React, data flows from the parent components to their children. When you see something wrong on the screen, you can trace where the information comes from by going up the component chain until you find which component passes the wrong prop or has the wrong state. When child components update the state of their parent components in Effects, the data flow becomes very difficult to trace. Since both the child and the parent component need the same data, let the parent component fetch that data, and pass it down to the child instead:
function Parent() {
const data = useSomeAPI();
// ...
// â
Good: Passing data down to the child
return <Child data={data} />;
}
function Child({ data }) {
// ...
}
This is simpler and keeps the data flow predictable: the data flows down from the parent to the child.
Subscribing to an external store
Sometimes, your components may need to subscribe to some data outside of the React state. This data could be from a third-party library or a built-in browser API. Since this data can change without Reactâs knowledge, you need to manually subscribe your components to it. This is often done with an Effect, for example:
function useOnlineStatus() {
// Not ideal: Manual store subscription in an Effect
const [isOnline, setIsOnline] = useState(true);
useEffect(() => {
function updateState() {
setIsOnline(navigator.onLine);
}
updateState();
window.addEventListener('online', updateState);
window.addEventListener('offline', updateState);
return () => {
window.removeEventListener('online', updateState);
window.removeEventListener('offline', updateState);
};
}, []);
return isOnline;
}
function ChatIndicator() {
const isOnline = useOnlineStatus();
// ...
}
Here, the component subscribes to an external data store (in this case, the browser navigator.onLine
API). Since this API does not exist on the server (so it canât be used to generate the initial HTML), initially the state is set to true
. Whenever the value of that data store changes in the browser, the component updates its state.
Although itâs common to use Effects for this, React has a purpose-built Hook for subscribing to an external store that is preferred instead. Delete the Effect and replace it with a call to useSyncExternalStore
:
function subscribe(callback) {
window.addEventListener('online', callback);
window.addEventListener('offline', callback);
return () => {
window.removeEventListener('online', callback);
window.removeEventListener('offline', callback);
};
}
function useOnlineStatus() {
// â
Good: Subscribing to an external store with a built-in Hook
return useSyncExternalStore(
subscribe, // React won't resubscribe for as long as you pass the same function
() => navigator.onLine, // How to get the value on the client
() => true // How to get the value on the server
);
}
function ChatIndicator() {
const isOnline = useOnlineStatus();
// ...
}
This approach is less error-prone than manually syncing mutable data to React state with an Effect. Typically, youâll write a custom Hook like useOnlineStatus()
above so that you donât need to repeat this code in the individual components. Read more about subscribing to external stores from React components.
Fetching data
Many apps use Effects to kick off data fetching. It is quite common to write a data fetching Effect like this:
function SearchResults({ query }) {
const [results, setResults] = useState([]);
const [page, setPage] = useState(1);
useEffect(() => {
// đ´ Avoid: Fetching without cleanup logic
fetchResults(query, page).then(json => {
setResults(json);
});
}, [query, page]);
function handleNextPageClick() {
setPage(page + 1);
}
// ...
}
You donât need to move this fetch to an event handler.
This might seem like a contradiction with the earlier examples where you needed to put the logic into the event handlers! However, consider that itâs not the typing event thatâs the main reason to fetch. Search inputs are often prepopulated from the URL, and the user might navigate Back and Forward without touching the input. It doesnât matter where page
and query
come from. While this component is visible, you want to keep results
synchronized with data from the network according to the current page
and query
. This is why itâs an Effect.
However, the code above has a bug. Imagine you type "hello"
fast. Then the query
will change from "h"
, to "he"
, "hel"
, "hell"
, and "hello"
. This will kick off separate fetches, but there is no guarantee about which order the responses will arrive in. For example, the "hell"
response may arrive after the "hello"
response. Since it will call setResults()
last, you will be displaying the wrong search results. This is called a ârace conditionâ: two different requests âracedâ against each other and came in a different order than you expected.
To fix the race condition, you need to add a cleanup function to ignore stale responses:
function SearchResults({ query }) {
const [results, setResults] = useState([]);
const [page, setPage] = useState(1);
useEffect(() => {
let ignore = false;
fetchResults(query, page).then(json => {
if (!ignore) {
setResults(json);
}
});
return () => {
ignore = true;
};
}, [query, page]);
function handleNextPageClick() {
setPage(page + 1);
}
// ...
}
This ensures that when your Effect fetches data, all responses except the last requested one will be ignored.
Handling race conditions is not the only difficulty with implementing data fetching. You might also want to think about how to cache the responses (so that the user can click Back and see the previous screen instantly instead of a spinner), how to fetch them on the server (so that the initial server-rendered HTML contains the fetched content instead of a spinner), and how to avoid network waterfalls (so that a child component that needs to fetch data doesnât have to wait for every parent above it to finish fetching their data before it can start). These issues apply to any UI library, not just React. Solving them is not trivial, which is why modern frameworks provide more efficient built-in data fetching mechanisms than writing Effects directly in your components.
If you donât use a framework (and donât want to build your own) but would like to make data fetching from Effects more ergonomic, consider extracting your fetching logic into a custom Hook like in this example:
function SearchResults({ query }) {
const [page, setPage] = useState(1);
const params = new URLSearchParams({ query, page });
const results = useData(`/api/search?${params}`);
function handleNextPageClick() {
setPage(page + 1);
}
// ...
}
function useData(url) {
const [data, setData] = useState(null);
useEffect(() => {
let ignore = false;
fetch(url)
.then(response => response.json())
.then(json => {
if (!ignore) {
setData(json);
}
});
return () => {
ignore = true;
};
}, [url]);
return data;
}
Youâll likely also want to add some logic for error handling and to track whether the content is loading. You can build a Hook like this yourself or use one of the many solutions already available in the React ecosystem. Although this alone wonât be as efficient as using a frameworkâs built-in data fetching mechanism, moving the data fetching logic into a custom Hook will make it easier to adopt an efficient data fetching strategy later.
In general, whenever you have to resort to writing Effects, keep an eye out for when you can extract a piece of functionality into a custom Hook with a more declarative and purpose-built API like useData
above. The fewer raw useEffect
calls you have in your components, the easier you will find to maintain your application.
Recap
- If you can calculate something during render, you donât need an Effect.
- To cache expensive calculations, add
useMemo
instead ofuseEffect
. - To reset the state of an entire component tree, pass a different
key
to it. - To reset a particular bit of state in response to a prop change, set it during rendering.
- Code that needs to run because a component was displayed should be in Effects, the rest should be in events.
- If you need to update the state of several components, itâs better to do it during a single event.
- Whenever you try to synchronize state variables in different components, consider lifting state up.
- You can fetch data with Effects, but you need to implement cleanup to avoid race conditions.
Challenge 1 of 4: Transform data without Effects
The TodoList
below displays a list of todos. When the âShow only active todosâ checkbox is ticked, completed todos are not displayed in the list. Regardless of which todos are visible, the footer displays the count of todos that are not yet completed.
Simplify this component by removing all the unnecessary state and Effects.
import { useState, useEffect } from 'react'; import { initialTodos, createTodo } from './todos.js'; export default function TodoList() { const [todos, setTodos] = useState(initialTodos); const [showActive, setShowActive] = useState(false); const [activeTodos, setActiveTodos] = useState([]); const [visibleTodos, setVisibleTodos] = useState([]); const [footer, setFooter] = useState(null); useEffect(() => { setActiveTodos(todos.filter(todo => !todo.completed)); }, [todos]); useEffect(() => { setVisibleTodos(showActive ? activeTodos : todos); }, [showActive, todos, activeTodos]); useEffect(() => { setFooter( <footer> {activeTodos.length} todos left </footer> ); }, [activeTodos]); return ( <> <label> <input type="checkbox" checked={showActive} onChange={e => setShowActive(e.target.checked)} /> Show only active todos </label> <NewTodo onAdd={newTodo => setTodos([...todos, newTodo])} /> <ul> {visibleTodos.map(todo => ( <li key={todo.id}> {todo.completed ? <s>{todo.text}</s> : todo.text} </li> ))} </ul> {footer} </> ); } function NewTodo({ onAdd }) { const [text, setText] = useState(''); function handleAddClick() { setText(''); onAdd(createTodo(text)); } return ( <> <input value={text} onChange={e => setText(e.target.value)} /> <button onClick={handleAddClick}> Add </button> </> ); }