-
Notifications
You must be signed in to change notification settings - Fork 24.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add example with side effect in render got triggered directly (#38830)
Summary: Pull Request resolved: #38830 Changelog: [Internal] - Add example with side effect in render got triggered directly Reviewed By: rshest Differential Revision: D48055836 fbshipit-source-id: 44544ebf19525bf43e1a78104bc870aecf36c7c9
- Loading branch information
1 parent
17e240b
commit 5a1c728
Showing
2 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
131 changes: 131 additions & 0 deletions
131
.../rn-tester/js/examples/Performance/performanceComparisonExamples/EffectInRenderExample.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
/** | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @flow strict-local | ||
* @format | ||
* @oncall react_native | ||
*/ | ||
|
||
'use strict'; | ||
|
||
import type {ItemDataType} from '../components/itemData'; | ||
|
||
import * as React from 'react'; | ||
import {useState, useEffect, useCallback, StrictMode} from 'react'; | ||
import {Text} from 'react-native'; | ||
import {generateRandomItems} from '../components/itemData'; | ||
import ItemList from '../components/ItemList'; | ||
|
||
const TIMEOUT = 500; | ||
const FETCH_COUNT = 250; | ||
const ItemListMemo = React.memo(ItemList); | ||
|
||
function ItemFetcherBadExample(props: { | ||
onFetched: (items: ItemDataType[]) => void, | ||
count: number, | ||
}): React.Node { | ||
const {onFetched, count} = props; | ||
const fetchMoreItems = async ( | ||
itemsCount: number, | ||
): Promise<ItemDataType[]> => { | ||
return new Promise(resolve => { | ||
setTimeout(() => { | ||
resolve(generateRandomItems(itemsCount)); | ||
}, TIMEOUT); | ||
}); | ||
}; | ||
|
||
fetchMoreItems(count).then((items: ItemDataType[]) => { | ||
onFetched(items); | ||
}, console.error); | ||
} | ||
|
||
function ItemFetcherGoodExample(props: { | ||
onFetched: (items: ItemDataType[]) => void, | ||
count: number, | ||
}): React.Node { | ||
const {onFetched, count} = props; | ||
useEffect(() => { | ||
const fetchMoreItems = async ( | ||
itemsCount: number, | ||
): Promise<ItemDataType[]> => { | ||
return new Promise(resolve => { | ||
setTimeout(() => { | ||
resolve(generateRandomItems(itemsCount)); | ||
}, TIMEOUT); | ||
}); | ||
}; | ||
|
||
fetchMoreItems(count).then((items: ItemDataType[]) => { | ||
onFetched(items); | ||
}, console.error); | ||
}, [onFetched, count]); | ||
} | ||
|
||
const ItemFetcherBadExampleMemo = React.memo(ItemFetcherBadExample); | ||
const ItemFetcherGoodExampleMemo = React.memo(ItemFetcherGoodExample); | ||
function EffectInRenderBadExample(): React.Node { | ||
const [visibleItems, setVisibleItems] = useState<ItemDataType[]>([]); | ||
const [fetchedItems, setFetchedItems] = useState<ItemDataType[]>([]); | ||
const onMoreItemFetched = useCallback( | ||
(items: ItemDataType[]) => { | ||
setFetchedItems(items); | ||
}, | ||
[setFetchedItems], | ||
); | ||
|
||
if (fetchedItems.length > 0) { | ||
setVisibleItems(visibleItems.concat(fetchedItems)); | ||
setFetchedItems([]); | ||
} | ||
|
||
return ( | ||
<StrictMode> | ||
<Text>{`Items count in list: ${visibleItems.length}`}</Text> | ||
<ItemFetcherBadExampleMemo | ||
onFetched={onMoreItemFetched} | ||
count={FETCH_COUNT} | ||
/> | ||
<ItemListMemo data={visibleItems} /> | ||
</StrictMode> | ||
); | ||
} | ||
|
||
function EffectInRenderGoodExample(): React.Node { | ||
const [visibleItems, setVisibleItems] = useState<ItemDataType[]>([]); | ||
const [fetchedItems, setFetchedItems] = useState<ItemDataType[]>([]); | ||
const onMoreItemFetched = useCallback( | ||
(items: ItemDataType[]) => { | ||
setFetchedItems(items); | ||
}, | ||
[setFetchedItems], | ||
); | ||
|
||
if (fetchedItems.length > 0) { | ||
setVisibleItems(visibleItems.concat(fetchedItems)); | ||
setFetchedItems([]); | ||
} | ||
|
||
return ( | ||
<StrictMode> | ||
<Text>{`Items count in list: ${visibleItems.length}`}</Text> | ||
<ItemFetcherGoodExampleMemo | ||
onFetched={onMoreItemFetched} | ||
count={FETCH_COUNT} | ||
/> | ||
<ItemListMemo data={visibleItems} /> | ||
</StrictMode> | ||
); | ||
} | ||
|
||
export default { | ||
title: | ||
'Directly trigger side effect in render may run multiple times and cause error state or re-renders', | ||
description: | ||
'Trigger a side effect in render method without using effect hook in <StrictMode>. This will force render component two times, and the side effect in bad example caused append items to the list two times unexpectedly.', | ||
Bad: EffectInRenderBadExample, | ||
Good: EffectInRenderGoodExample, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters