Skip to content

fix: ignore stale FlashList item layouts - #91248

Merged
pecanoro merged 4 commits into
Expensify:mainfrom
KJ21-ENG:KJ21-ENG/89933-flashlist-stale-layout
May 22, 2026
Merged

pecanoro merged 4 commits into
Expensify:mainfrom
KJ21-ENG:KJ21-ENG/89933-flashlist-stale-layout

Conversation

@KJ21-ENG

@KJ21-ENG KJ21-ENG commented May 20, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR adds a new @shopify/flash-list patch for v2.3.0 that ignores stale ViewHolder.onLayout measurements after the list data/layout table has changed.

validateItemSize previously read the stored layout with recyclerViewManager.getLayout(index). That method throws when an obsolete render-time index is no longer present in the layout manager, which can happen when a stale layout callback lands after the FlashList data has already changed during navigation.

The patch switches that validation path to recyclerViewManager.tryGetLayout(index) and returns early when the layout is missing. Current indexes still go through the existing width/height validation, so the change only skips obsolete measurements that no longer have a matching stored layout.

Fixed Issues

$ #89933
PROPOSAL: #89933 (comment)

Tests

  • Verify that no errors appear in the JS console
  1. Open the app.
  2. Open a report that renders the main chat list.
  3. Trigger the DEW submit failure state from the affected flow.
  4. While still on the report, immediately navigate back so FlashList transitions away from the report while stale item layout callbacks can still arrive.
  5. Verify the app navigates back without crashing.
  6. Reopen the same report.
  7. Scroll the report list and verify messages continue to render correctly.
  8. Navigate away from and back to the report again.
  9. Verify no crash occurs and no new JS console errors are shown.

Targeted checks run:

  1. Verified the new FlashList patch file parses successfully through patch-package's parser.
  2. Verified the new FlashList patch can be reversed from patched files and dry-run applied again.
  3. Ran npx prettier --check patches/@shopify/flash-list/details.md.
  4. Ran git diff --check upstream/main...HEAD.

Offline tests

N/A. This package patch only guards stale local FlashList layout callbacks and does not change network behavior.

QA Steps

  • Verify that no errors appear in the JS console
  1. Sign in to a staging account that can access the affected DEW submit failure flow.
  2. Open a report that renders the main chat list.
  3. Trigger the DEW submit failure state from the affected flow.
  4. While still on the report, immediately navigate back so FlashList transitions away from the report while stale item layout callbacks can still arrive.
  5. Verify the app navigates back without crashing.
  6. Reopen the same report.
  7. Scroll the report list and verify messages continue to render correctly.
  8. Navigate away from and back to the report again.
  9. Verify no crash occurs and no new JS console errors are shown.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

N/A. This patch has no visible UI change. The Android-native crash validation is covered by the test steps above.

Android: mWeb Chrome

N/A. This patch has no visible UI change.

iOS: Native

N/A. This patch has no visible UI change.

iOS: mWeb Safari

N/A. This patch has no visible UI change.

MacOS: Chrome / Safari

N/A. This patch has no visible UI change.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@KJ21-ENG KJ21-ENG changed the title [WIP] fix: ignore stale FlashList item layouts fix: ignore stale FlashList item layouts May 21, 2026
@KJ21-ENG
KJ21-ENG marked this pull request as ready for review May 21, 2026 08:31
@KJ21-ENG
KJ21-ENG requested a review from a team as a code owner May 21, 2026 08:31
@melvin-bot
melvin-bot Bot requested review from linhvovan29546 and removed request for a team May 21, 2026 08:31
@melvin-bot

melvin-bot Bot commented May 21, 2026

Copy link
Copy Markdown

@linhvovan29546 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@linhvovan29546

linhvovan29546 commented May 22, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
telegram-cloud-document-5-6091433261286827359.mp4
Android: mWeb Chrome
telegram-cloud-document-5-6091433261286827361.mp4
iOS: HybridApp
Screen.Recording.2026-05-22.at.20.12.22.mov
iOS: mWeb Safari
Screen.Recording.2026-05-22.at.20.00.50.mov
Screen.Recording.2026-05-22.at.20.00.37.mov
MacOS: Chrome / Safari
Screen.Recording.2026-05-22.at.19.57.07.mov

@linhvovan29546

Copy link
Copy Markdown
Contributor

@KJ21-ENG Could you please create an upstream issue?

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@linhvovan29546 Created the upstream issue here: Shopify/flash-list#2291. I also updated the FlashList patch details to reference it.

@linhvovan29546

Copy link
Copy Markdown
Contributor

@KJ21-ENG Please add a unit test for this. You can use the test I copied here

import {FlashList} from '@shopify/flash-list';
import {render} from '@testing-library/react-native';
import React from 'react';
import type {LayoutChangeEvent, View as RNView, ViewStyle} from 'react-native';
import {View} from 'react-native';

type CellProps = {
    index: number;
    onLayout: (event: LayoutChangeEvent) => void;
    style: ViewStyle;
    children: React.ReactNode;
};

describe('FlashList - stale onLayout after rapid data change', () => {
    it('does not throw when ViewHolder onLayout fires with a now out-of-bounds index', () => {
        // Map of index -> captured onLayout handler from each ViewHolder render
        const capturedLayoutHandlers = new Map<number, (event: LayoutChangeEvent) => void>();

        const CapturingCell = React.forwardRef<RNView, CellProps>(({index, onLayout, style, children}, ref) => {
            capturedLayoutHandlers.set(index, onLayout);
            return (
                <View
                    ref={ref}
                    onLayout={onLayout}
                    style={style}
                >
                    {children}
                </View>
            );
        });
        CapturingCell.displayName = 'CapturingCell';

        const renderItem = ({item}: {item: {id: number}}) => (
            <View
                testID={`item-${item.id}`}
                style={{height: 50}}
            />
        );

        const initialData = Array.from({length: 10}, (_, i) => ({id: i}));
        const shrunkData = initialData.slice(0, 2);

        const {rerender} = render(
            <FlashList
                data={initialData}
                keyExtractor={(item) => String(item.id)}
                renderItem={renderItem}
                CellRendererComponent={CapturingCell}
            />,
        );

        // Quickly shrink data
        rerender(
            <FlashList
                data={shrunkData}
                keyExtractor={(item) => String(item.id)}
                renderItem={renderItem}
                CellRendererComponent={CapturingCell}
            />,
        );

        // Pick a handler that was captured for an index now beyond the new
        // data length. In production the browser would fire this from a
        // queued ResizeObserver callback after the data shrunk.
        const staleIndex = [...capturedLayoutHandlers.keys()].find((idx) => idx >= shrunkData.length);
        expect(staleIndex).toBeDefined();
        const staleOnLayout = staleIndex ? capturedLayoutHandlers.get(staleIndex) : undefined;
        expect(staleOnLayout).toBeDefined();

        // Pre-fix: this throws "index out of bounds, not enough layouts"
        // Post-fix: validateItemSize bails when tryGetLayout returns undefined
        expect(() => {
            staleOnLayout?.({
                nativeEvent: {
                    layout: {x: 0, y: 0, width: 100, height: 50},
                },
            } as LayoutChangeEvent);
        }).not.toThrow();
    });
});

Comment thread patches/@shopify/flash-list/details.md Resolved
@KJ21-ENG

KJ21-ENG commented May 22, 2026 •

Copy link
Copy Markdown
Contributor Author

@linhvovan29546 Added the stale FlashList onLayout regression test and updated patch 009 with the PR link.

@VickyStash VickyStash mentioned this pull request May 22, 2026
52 tasks done
@linhvovan29546

Copy link
Copy Markdown
Contributor

@KJ21-ENG Please add QA step

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@linhvovan29546 Added explicit QA steps to the PR description.

@pecanoro
pecanoro merged commit ba143e8 into Expensify:main May 22, 2026
51 of 52 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @pecanoro has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify OSBotify mentioned this pull request May 22, 2026
71 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/pecanoro in version: 9.3.80-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.3.81-2 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants