Skip to content

Optimize LHN sidebar sorting with pre-computed sort keys#87847

Merged
mountiny merged 8 commits into
Expensify:mainfrom
callstack-internal:perf/optimize-lhn-sorting
Apr 17, 2026
Merged

Optimize LHN sidebar sorting with pre-computed sort keys#87847
mountiny merged 8 commits into
Expensify:mainfrom
callstack-internal:perf/optimize-lhn-sorting

Conversation

@TMisiukiewicz

@TMisiukiewicz TMisiukiewicz commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

The LHN sidebar sort previously called Intl.Collator.compare() on every comparison in every sort pass — roughly 230k calls per sort on a large account. Each call is expensive because Intl.Collator must apply locale-sensitive Unicode collation rules at call time.

This PR replaces that approach with pre-computed sort keys: each report name is lowercased and has its numeric segments zero-padded, then cached at module level. Sorting then compares plain strings (fast), and only falls back to Intl.Collator when two sort keys are identical (ties — roughly 1,050 out of 230k comparisons in practice).

The tradeoff: locale-specific diacritic ordering (Swedish ä/ö, German ß, Spanish ñ) now uses Unicode codepoint order rather than locale-aware order. Numeric sorting is fully preserved.

Performance results:

  • iOS: 740ms → 164ms (~78% reduction)
  • Android: 2.1s -> 380ms (~82% reduction)

Fixed Issues

$ #87939
PROPOSAL:

Tests

  1. Open the app on fresh account
  2. Start 2 new chats
  3. Pin any chat
  4. Verify it went on top of the list
  5. Start typing in the last chat
  6. Verify it went on 2nd position
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • 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
      • 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
Android: mWeb Chrome
iOS: Native
ios.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mov

@codecov

codecov Bot commented Apr 14, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/SidebarUtils.ts 80.69% <84.21%> (+0.08%) ⬆️
... and 14 files with indirect coverage changes

@TMisiukiewicz TMisiukiewicz changed the title [No QA] Optimize LHN sidebar sorting with pre-computed sort keys Optimize LHN sidebar sorting with pre-computed sort keys Apr 14, 2026
@TMisiukiewicz TMisiukiewicz marked this pull request as ready for review April 15, 2026 07:46
@TMisiukiewicz TMisiukiewicz requested review from a team as code owners April 15, 2026 07:46
@melvin-bot melvin-bot Bot requested review from abzokhattab and flaviadefaria and removed request for a team April 15, 2026 07:46
@melvin-bot

melvin-bot Bot commented Apr 15, 2026

Copy link
Copy Markdown

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: db5abdd5b1

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/libs/SidebarUtils.ts
avasis-ai pushed a commit to avasis-ai/App that referenced this pull request Apr 15, 2026
)

Replace per-comparison localeCompare calls in sortCategorizedReports with
a precomputed sort-key map. The map is built once per sort pass from all
display names across the five LHN categories, then garbage-collected.

Sort keys use NFKD normalization + lowercasing + zero-padded numerics for
fast string < comparison. localeCompare is only invoked as a tiebreaker
when two sort keys are identical.

Advantages over module-level Map cache approach (PR Expensify#87847):
- No unbounded cache / memory leak — the map is local to each sort pass
- No new field on MiniReport — same type, smaller change surface
- Natural numeric ordering (Report 2 before Report 10) without
  requiring Intl.Collator with numeric:true on every comparison
@abzokhattab

Copy link
Copy Markdown
Contributor

@codex review

@abzokhattab

Copy link
Copy Markdown
Contributor

@MelvinBot review the PR

@MelvinBot

Copy link
Copy Markdown
Contributor

PR Review

Good performance optimization — reducing 230k Intl.Collator calls to ~1k is a significant win. A few concerns:

1. Unbounded sortKeyCache (memory leak)

sortKeyCache at src/libs/SidebarUtils.ts:232 is a module-level Map that grows forever. Every unique displayName adds an entry that's never removed. When users rename chats or encounter new contacts, old entries accumulate as dead weight.

Suggestion: Clear the cache at the start of categorizeReportsForLHN() — it rebuilds all sort keys each call anyway, so stale entries provide no benefit between sort cycles:

sortKeyCache.clear();

2. Locale-aware ordering is effectively lost

The existing Intl.Collator is configured with sensitivity: 'variant', caseFirst: 'upper', and locale awareness. The new code:

  • toLowerCase() destroys caseFirst: 'upper' ordering
  • Plain < / > comparison uses Unicode code points instead of locale-aware rules
  • The Intl.Collator fallback only fires when sort keys are exactly equal, so accented characters (é vs e, ä vs a, ñ vs n) will never reach the fallback

For English-only names this is fine, but for internationalized names the sort order may visibly change. The PR description acknowledges this tradeoff for diacritics, but the caseFirst loss isn't mentioned.

Question for author: Is the caseFirst: 'upper' behavior from the existing collator intentionally being dropped? If so, worth noting in the PR description.

3. Minor: /g flag on DIGIT_SEQUENCE regex

replaceAll requires the /g flag, so this is correct. No issue here — just confirming.

4. Tests only cover ASCII

The test updates are mechanical (adding sortKey to test data), but there's no test coverage for the behavioral change with accented/internationalized characters. Adding a test case like "Café" vs "Cafe" would document the expected behavior under the new approach.

Summary
Concern Severity Action needed
Unbounded cache Medium Add sortKeyCache.clear() at start of categorize function
Locale ordering lost Low-Medium Acknowledge caseFirst loss; consider if acceptable
No i18n test coverage Low Add accented character test case

Next Steps: Reply with @MelvinBot <your feedback> to discuss any of these points.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2fd027117a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/libs/SidebarUtils.ts
Comment thread src/libs/SidebarUtils.ts
@MelvinBot

Copy link
Copy Markdown
Contributor

Updated Review

The latest commit (753cc05) addresses the two main concerns from my previous review:

  1. Cache cleared per cyclesortKeyCache.clear() is now called at the start of categorizeReportsForLHN(). No more unbounded growth. ✅
  2. i18n test coverage addedbuildSortKey tests now cover accented characters (Café vs Cafe), case-insensitivity, and numeric zero-padding. ✅

Remaining minor note: The caseFirst: 'upper' behavior from the original Intl.Collator is still silently dropped (uppercase no longer sorts before lowercase for identical strings). This is low-severity since toLowerCase() makes all keys uniform and the collator fallback handles ties, but worth being aware of.

Overall this looks good — clean implementation with solid perf gains.

@abzokhattab

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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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-04-17.at.01.56.00.mov
Android: mWeb Chrome
Screen.Recording.2026-04-17.at.01.50.40.mov
iOS: HybridApp
Screen.Recording.2026-04-17.at.01.56.00.mov
iOS: mWeb Safari
Screen.Recording.2026-04-17.at.01.50.40.mov
MacOS: Chrome / Safari
Screen.Recording.2026-04-17.at.01.48.21.mov

@abzokhattab

Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 753cc055fa

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/libs/SidebarUtils.ts
return cached;
}

const key = displayName.toLowerCase().replaceAll(DIGIT_SEQUENCE, (match) => match.padStart(NUMERIC_PAD_WIDTH, '0'));

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Handle numeric segments longer than 15 digits

The fixed-width padding in buildSortKey() regresses numeric ordering for names containing digit runs longer than 15 characters. With NUMERIC_PAD_WIDTH = 15, comparing "Report 999999999999999" and "Report 1000000000000000" produces sort keys where the 16-digit value sorts before the 15-digit one lexicographically, so the sidebar order becomes incorrect for long numeric identifiers. The previous Intl.Collator(..., {numeric: true}) path handled arbitrary-length numeric segments, so this is a functional regression whenever users include long numbers in report names.

Useful? React with 👍 / 👎.

@abzokhattab abzokhattab left a comment

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.

LGTM

@melvin-bot melvin-bot Bot requested a review from mountiny April 17, 2026 00:18

@mountiny mountiny left a comment

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.

Thanks

@mountiny mountiny merged commit 8737238 into Expensify:main Apr 17, 2026
34 checks passed
@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.

@github-actions

Copy link
Copy Markdown
Contributor

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.61-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site changes are needed for this PR.

The changes are a performance optimization to the internal LHN sidebar sorting algorithm (pre-computed sort keys replacing per-comparison Intl.Collator calls). No user-facing features, UI labels, settings, or workflows were added or changed.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.3.61-4 🚀

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.

5 participants