Skip to content

Prevent LHN crash on undefined item and out-of-range web scroll index#91488

Open
wildan-m wants to merge 4 commits into
Expensify:mainfrom
wildan-m:wildan/91226-lhn-options-list-undefined-item
Open

Prevent LHN crash on undefined item and out-of-range web scroll index#91488
wildan-m wants to merge 4 commits into
Expensify:mainfrom
wildan-m:wildan/91226-lhn-options-list-undefined-item

Conversation

@wildan-m
Copy link
Copy Markdown
Contributor

@wildan-m wildan-m commented May 23, 2026

Explanation of Change

On web, the app could crash with a TypeError while rendering the left-hand navigation list. The list's row renderer read a report's ID as its very first step, without checking that the row actually existed.

This was reachable because, on web only, the list restores a previously saved scroll position when it mounts. That position is never re-validated against the current list, which grows and shrinks constantly (reports archived or deleted, filters applied, priority mode toggled, accounts switched). Once the list had shrunk below the saved position, the list component looked up a row that no longer existed and passed an empty row to the renderer, which crashed reading the report's ID. On native the saved position is not used, which is why the crash was web-only.

This fixes both layers. The row renderer now returns an empty row when it has no data, instead of reading the report's ID — consistent with the rest of that callback, which already treats the row as possibly missing. And the saved web scroll position is now used only when it still falls within the current list; otherwise the list starts at the top. The second change removes the actual trigger, and the first guarantees the crash cannot happen regardless of how an empty row arrives.

The only behavioral change is in the out-of-range case: when the saved web scroll position no longer fits the list, the navigation starts at the top instead of crashing. When the saved position is still valid, behavior is unchanged.

Fixed Issues

$ #91226
PROPOSAL: #91226 (comment)

Tests

This is a non-deterministic crash reported through Sentry — the issue lists reproduction as "Unknown" (it happens during a concurrent-rendering recovery race when the left-hand navigation (LHN) list shrinks below a previously saved web scroll index, so it can't be triggered by normal use). The patch below forces the underlying out-of-range-index condition deterministically, on any account — no need for many chats.

Deterministic reproduction (any account size)

The crash needs the saved web scroll index to point past the end of the current list. You can't naturally save a high index on a short list, so temporarily force getScrollIndex to return an out-of-range value. This file is not modified by this PR, so the exact same patch applies to both main and this branch.

In src/components/ScrollOffsetContextProvider.tsx, replace the body of getScrollIndex:

-    const getScrollIndex: ScrollOffsetContextValue['getScrollIndex'] = useCallback((route) => {
-        if (!scrollOffsetsRef.current) {
-            return;
-        }
-        return scrollOffsetsRef.current[getKey(route)];
-    }, []);
+    const getScrollIndex: ScrollOffsetContextValue['getScrollIndex'] = useCallback(() => {
+        // TEMP: force an out-of-range saved scroll index to reproduce the LHN crash
+        return 9999;
+    }, []);
  1. On main with the patch applied: open the app on web and sign in. The LHN crashes into the "Uh-oh, something went wrong!" error boundary on load. The JS console shows crash caught by error boundary - index out of bounds, not enough layouts with a component stack through LHNOptionsList. (This is the deterministic, mount-time sibling of the production t.reportID race — same root cause: an out-of-range index reaching FlashList.)
  2. On this PR branch with the same patch applied: open the app on web and sign in. The LHN renders normally and starts at the top — no crash, clean console. The fix clamps the out-of-range index to "start at the top."
  3. Remove the patch when done.

Regression checks (real fix in place, no patch)

  1. On web, scroll the LHN up and down and open/switch between several chats; confirm everything renders with no crash.
  2. Run the unit tests: npx jest tests/ui/components/LHNOptionsListTest.tsx tests/ui/components/LHNOptionsListRenderItemTest.tsx. They cover the scroll-index validation (in range, past the end, negative, empty list, no saved index) and the guard that returns an empty row for a missing item.
  • Verify that no errors appear in the JS console

Offline tests

No offline-specific behavior changes. The LHN renders the same offline; the guards only change what happens when the list shrinks (which can also occur offline during an optimistic delete) — preventing the crash and starting at the top when the saved scroll position is out of range.

QA Steps

This crash can't be reproduced on demand — it's a non-deterministic race, and the deterministic repro in the Tests section needs a local code patch that doesn't apply on staging. QA can confirm there's no regression in the left-hand navigation (LHN). This works on any account and does not depend on how many chats it has:

  1. On web (staging), sign in to any account.
  2. Confirm the LHN (the list of chats on the left) loads and renders correctly.
  3. Scroll the LHN up and down, then open and switch between a few chats; confirm the correct chat opens each time and nothing crashes.
  • Verify that no errors appear in the JS console

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
    • 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
Kapture.2026-05-23.at.13.25.23.mp4
Android: mWeb Chrome
Kapture.2026-05-23.at.13.29.33.mp4
iOS: Native
Kapture.2026-05-23.at.13.17.23.mp4
iOS: mWeb Safari
Kapture.2026-05-23.at.13.20.53.mp4
MacOS: Chrome / Safari
Kapture.2026-05-23.at.11.47.49_compressed.mp4

wildan-m added 4 commits May 21, 2026 15:40
…index

Guard renderItem against a transient undefined item instead of reading
item.reportID directly, and only restore the saved web scroll index when
it is still within the current data range so FlashList is never asked to
render a non-existent row.
Move the in-range scroll-index validation into a small pure helper so it can be
unit-tested directly, and add tests covering the index validation (in-range,
out-of-range, negative, empty list, no saved index) and the renderItem guard
returning null for an undefined item.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 23, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/components/LHNOptionsList/LHNOptionsList.tsx 81.25% <100.00%> (+1.93%) ⬆️
... and 11 files with indirect coverage changes

@wildan-m wildan-m marked this pull request as ready for review May 23, 2026 06:34
@wildan-m wildan-m requested review from a team as code owners May 23, 2026 06:34
@melvin-bot melvin-bot Bot requested review from gijoe0295 and removed request for a team May 23, 2026 06:34
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 23, 2026

@gijoe0295 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]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this test. This is niche

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Comment on lines +74 to +76
// FlashList can momentarily hand us an undefined item while the list shrinks before the
// recycler rebuilds. Bail out for that transient slot instead of reading item.reportID and
// crashing. The rest of this callback already guards item with optional chaining.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// FlashList can momentarily hand us an undefined item while the list shrinks before the
// recycler rebuilds. Bail out for that transient slot instead of reading item.reportID and
// crashing. The rest of this callback already guards item with optional chaining.

const itemOneTransactionThreadReport = reports?.[`${ONYXKEYS.COLLECTION.REPORT}${itemReportAttributes?.oneTransactionThreadReportID}`];

let invoiceReceiverPolicyID = '-1';
if (item?.invoiceReceiver && 'policyID' in item.invoiceReceiver) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (item.invoiceReceiver && 'policyID' in item.invoiceReceiver) {

invoiceReceiverPolicyID = itemParentReport.invoiceReceiver.policyID;
}
const itemInvoiceReceiverPolicy = policy?.[`${ONYXKEYS.COLLECTION.POLICY}${invoiceReceiverPolicyID}`];
const itemPolicy = policy?.[`${ONYXKEYS.COLLECTION.POLICY}${item?.policyID}`];
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const itemPolicy = policy?.[`${ONYXKEYS.COLLECTION.POLICY}${item.policyID}`];

});
}, [getScrollOffset, route]);

const initialScrollIndex = getInitialScrollIndex(isWeb ? getScrollIndex(route) : undefined, data.length);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const initialScrollIndex = getInitialScrollIndex(isWeb ? getScrollIndex(route) : undefined, data.length);
const savedScrollIndex = getScrollIndex(route);
const initialScrollIndex = isWeb && savedScrollIndex && savedScrollIndex >= 0 && savedScrollIndex < data.length ? savedScrollIndex : undefined;

Comment on lines +28 to +40
/**
* Restores the saved web scroll index only when it is still in range. The list length changes
* constantly (archived/deleted reports, filters, priority mode, account switches), so a saved index
* can point past the end. Returning undefined makes FlashList start at the top instead of looking up
* data[index] === undefined and handing renderItem a missing item.
*/
function getInitialScrollIndex(savedScrollIndex: number | undefined, dataLength: number): number | undefined {
if (savedScrollIndex === undefined || savedScrollIndex < 0 || savedScrollIndex >= dataLength) {
return undefined;
}
return savedScrollIndex;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/**
* Restores the saved web scroll index only when it is still in range. The list length changes
* constantly (archived/deleted reports, filters, priority mode, account switches), so a saved index
* can point past the end. Returning undefined makes FlashList start at the top instead of looking up
* data[index] === undefined and handing renderItem a missing item.
*/
function getInitialScrollIndex(savedScrollIndex: number | undefined, dataLength: number): number | undefined {
if (savedScrollIndex === undefined || savedScrollIndex < 0 || savedScrollIndex >= dataLength) {
return undefined;
}
return savedScrollIndex;
}

@gijoe0295
Copy link
Copy Markdown
Contributor

gijoe0295 commented May 25, 2026

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
Screen.Recording.2026-05-26.at.01.07.18.mov
Android: mWeb Chrome
Screen.Recording.2026-05-26.at.01.11.47.mov
iOS: HybridApp
Screen.Recording.2026-05-26.at.01.14.16.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2026-05-26.at.01.02.06.mov

@gijoe0295
Copy link
Copy Markdown
Contributor

gijoe0295 commented May 25, 2026

Let's remove the redundant wordy explanation from PR body. The Explanation of Change section can be simplified. Offline tests can just be None. Remove the explanation on top of QA tests: "This crash can't be reproduced on demand ...". Same for Tests section.

@mountiny mountiny requested a review from Copilot May 26, 2026 12:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

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.

3 participants