Speedup `getOrderedReportIDs` by compering strings instead of Dates objects #28000

Szymon20000 · 2023-09-22T09:42:50Z

Details

For some reason creating Date object is super slow on Hermes. So @janicduplessis came up with the idea to compare strings instead.

Result:
the method now runs under 1s instead of 14s (when starting heavy accounts provided by @danieldoglas)

Fixed Issues

$#28001

$
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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.
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Simulator.Screen.Recording.-.iPhone.15.-.2023-09-22.at.13.59.47.mp4

melvin-bot · 2023-09-22T09:43:30Z

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

mountiny · 2023-09-22T09:52:36Z

@Szymon20000 @janicduplessis lint is failing

Szymon20000 · 2023-09-22T11:02:11Z

@mountiny Fixed linting!

src/libs/SidebarUtils.js

Szymon20000 · 2023-09-22T11:12:26Z

I don't think this pr closes any existing issue.
Do I need to create one?

danieldoglas · 2023-09-22T11:14:10Z

That would be great. Just to explain why we did those changes. Then we link it to the performance project.

Szymon20000 · 2023-09-22T12:01:41Z

Added just one video as the change just optimises sorting and it has to work on all platforms if it works on one.

allroundexperts · 2023-09-22T12:04:14Z

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 tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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(themeColors.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 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.
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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

waterim · 2023-09-22T12:10:54Z

Added few comments, but good job!

Szymon20000 · 2023-09-22T13:47:33Z

I don't see any comments. :D

src/libs/SidebarUtils.js

waterim · 2023-09-22T12:07:41Z

src/libs/SidebarUtils.js

    if (isInDefaultMode) {
        nonArchivedReports.sort(
-            (a, b) => new Date(b.lastVisibleActionCreated) - new Date(a.lastVisibleActionCreated) || a.displayName.toLowerCase().localeCompare(b.displayName.toLowerCase()),
+            (a, b) => compareStringDates(a.lastVisibleActionCreated, b.lastVisibleActionCreated) || a.displayName.toLowerCase().localeCompare(b.displayName.toLowerCase()),


here we had new Date(b.lastVisibleActionCreated) - new Date(a.lastVisibleActionCreated)
Please change to: compareStringDates(b.lastVisibleActionCreated, a.lastVisibleActionCreated)

That would reverse the order.

Yes, thats the point how it was done before

Then tests won't pass. I can change values in the comparator function but it doesn't make sense for me.
(a, b) => cmp(a, b) is cleaner then (a, b) => cmp(b, a)

ah I see what you meant. Once we extract it outside of the function it will make sense

waterim · 2023-09-22T13:50:36Z

@Szymon20000 forgot to request changes... 😄

allroundexperts · 2023-09-24T17:51:13Z

@Szymon20000 Lint is failing

allroundexperts

Looks good other than the lint changes!

melvin-bot · 2023-09-25T03:32:12Z

🎯 @allroundexperts, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #28107.

mountiny · 2023-09-25T04:15:47Z

@Szymon20000 Lets fix the lint and

Addressed

mountiny

Thanks for resolving the lint issues, going to merge and deploy the app

OSBotify · 2023-09-25T10:03:27Z

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

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-09-28T18:45:48Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

compare strings instead of dates

f8a9b73

Szymon20000 requested a review from a team as a code owner September 22, 2023 09:42

melvin-bot bot requested review from Beamanator and removed request for a team September 22, 2023 09:43

mountiny assigned Szymon20000 Sep 22, 2023

mountiny self-requested a review September 22, 2023 09:48

Szymon20000 marked this pull request as draft September 22, 2023 09:53

Szymon20000 added 2 commits September 22, 2023 12:53

fix order

4ffde03

linting

5245335

danieldoglas previously requested changes Sep 22, 2023

View reviewed changes

src/libs/SidebarUtils.js Outdated Show resolved Hide resolved

applysuggestions

7483d2d

Szymon20000 added 2 commits September 22, 2023 13:23

fx linting

53c0f76

Merge branch 'main' into @szymon/compare_strings

ea42990

Szymon20000 marked this pull request as ready for review September 22, 2023 12:01

waterim suggested changes Sep 22, 2023

View reviewed changes

apply suggestions

9c82382

allroundexperts approved these changes Sep 25, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-06] [$500]Payment issue for E/App PR#28000 #28107

Closed

Merge branch 'Expensify:main' into @szymon/compare_strings

adcb854

mountiny approved these changes Sep 25, 2023

View reviewed changes

mountiny merged commit 6461bfa into Expensify:main Sep 25, 2023
12 checks passed

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

janicduplessis deleted the @szymon/compare_strings branch September 25, 2023 11:47

janicduplessis restored the @szymon/compare_strings branch September 25, 2023 11:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Speedup `getOrderedReportIDs` by compering strings instead of Dates objects #28000

Speedup `getOrderedReportIDs` by compering strings instead of Dates objects #28000

Szymon20000 commented Sep 22, 2023 •

edited

Loading

melvin-bot bot commented Sep 22, 2023

mountiny commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

danieldoglas commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

allroundexperts commented Sep 22, 2023 •

edited

Loading

waterim commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

waterim Sep 22, 2023

Szymon20000 Sep 22, 2023

waterim Sep 22, 2023

Szymon20000 Sep 22, 2023

Szymon20000 Sep 22, 2023

waterim commented Sep 22, 2023

allroundexperts commented Sep 24, 2023

allroundexperts left a comment

melvin-bot bot commented Sep 25, 2023

mountiny commented Sep 25, 2023

mountiny left a comment

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

Speedup getOrderedReportIDs by compering strings instead of Dates objects #28000

Speedup getOrderedReportIDs by compering strings instead of Dates objects #28000

Conversation

Szymon20000 commented Sep 22, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 22, 2023

mountiny commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

danieldoglas commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

allroundexperts commented Sep 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

waterim commented Sep 22, 2023

Szymon20000 commented Sep 22, 2023

waterim Sep 22, 2023

Choose a reason for hiding this comment

Szymon20000 Sep 22, 2023

Choose a reason for hiding this comment

waterim Sep 22, 2023

Choose a reason for hiding this comment

Szymon20000 Sep 22, 2023

Choose a reason for hiding this comment

Szymon20000 Sep 22, 2023

Choose a reason for hiding this comment

waterim commented Sep 22, 2023

allroundexperts commented Sep 24, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 25, 2023

mountiny commented Sep 25, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

Speedup `getOrderedReportIDs` by compering strings instead of Dates objects #28000

Speedup `getOrderedReportIDs` by compering strings instead of Dates objects #28000

Szymon20000 commented Sep 22, 2023 •

edited

Loading

allroundexperts commented Sep 22, 2023 •

edited

Loading