SectionList unnecessarily unmounts and mounts items when filtering (in between renders)
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C++
- Estrellas
- 127k
- Forks
- 25.3k
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 4
Descripción
Description
When a SectionList rerenders, sometimes it unmounts and remounts some of its items unnecessarily, even though the items preserve the same "key" prop in between renders. This impacts performance.
A scenario where this could happen is when filtering data. Imagine a SectionList with a search bar (TextInput) above it. Every time the user types something in the search bar, the section list gets filtered so it shows the items that contain the text in the search bar. Sometimes, the items get remounted unnecessarily when typing (Why remount an item when it was already there? It passed the filter, it should stay there.)
React Native version:
System:
OS: Windows 10 10.0.18363
CPU: (8) x64 Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz
Memory: 6.52 GB / 15.87 GB
Binaries:
Node: 12.14.0 - C:\Program Files\nodejs\node.EXE
Yarn: Not Found
npm: 6.13.4 - C:\Program Files\nodejs\npm.CMD
Watchman: Not Found
SDKs:
Android SDK: Not Found
IDEs:
Android Studio: Version 3.6.0.0 AI-192.7142.36.36.6392135
Languages:
Java: Not Found
Python: 2.7.17 - C:\Python27\python.EXE
npmPackages:
@react-native-community/cli: Not Found
react: 16.11.0 => 16.11.0
react-native: 0.62.2 => 0.62.2
npmGlobalPackages:
react-native: Not Found
Steps To Reproduce
- Create a new react-native project.
npx react-native init sectionlisttest - Modify the App.js file so it looks like the following.
import React, {useEffect, useState} from 'react';
import {SectionList, Text, View} from 'react-native';
const originalData = [{
key: 'header1',
header: 'Header 1',
data: [{key: 'firstItem'}, {key: 'byebye1'}],
}];
const filteredData = [{
key: 'header1',
header: 'Header 1',
data: [{key: 'firstItem'}],
}];
export default function App() {
useEffect(() => {
setTimeout(() => setSections(filteredData), 5000);
}, []);
const [sections, setSections] = useState(originalData);
return (
<SectionList
sections={sections}
renderItem={renderItem}
renderSectionHeader={renderSectionHeader}
ItemSeparatorComponent={Separator}
/>
);
}
const renderItem = ({item}) => <Item item={item} />;
const Item = ({item}) => {
useEffect(() => {
console.log('item mounted');
}, []);
return <Text>{item.key}</Text>;
};
const renderSectionHeader = ({section}) => <Text>{section.header}</Text>;
const Separator = () => <View style={{height: 1, backgroundColor: 'black'}} />;
- Run the app. I ran it in Android (
npx react-native run-android).
IMPORTANT: Fully reload the app, don't depend on hot reloading.
Expected Results
Expected result: 2 lines saying "Item mounted" get printed to the logs.
Actual Result: 2 lines saying "Item mounted" get printed to the logs. . But then, 5 seconds later, it prints a third line also saying "Item mounted".
Snack, code example, screenshot, or link to a repository:
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduce el comportamiento del ejemplo de App.js o del Snack enlazado, usando la transición de datos de SectionList después de cinco segundos. Rastrea qué elementos se montan durante la actualización y revisa el comportamiento de renderizado y la gestión de keys de SectionList. Se considera completado cuando filtrar o actualizar secciones ya no monta innecesariamente un elemento que conserva la misma key, con una prueba de regresión que cubra el escenario.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, react-native
- Área
- mobile
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100