perf: remove sorting from `findLastAccessedReport` #44948

kosmydel · 2024-07-08T09:57:35Z

Details

This is the first PR of ReportScreen performance improvement.

In this PR we are improving the findLastAccessedReport function improvement, by removing the sorting of the reports. Instead, we perform filtering first and then search for the latest report.

This change improves the findLastAccessedReport execution time: 0.51ms -> 0.12ms (76.56% less time).

Fixed Issues

$ #44925
PROPOSAL:

Tests

Note

When testing, sometimes the lastVisitedPath might be loaded and the findLastAccessedReport function might not be called. To avoid this, you can add return undefined; at the beggining of the NavigationRoot -> initialState function.

Web:

Last accessed report

Remember the last accessed report
Remove the reportID from the URL (go to e.g. https://staging.new.expensify.com/ and remove the reportID from the URL)
Load the page and verify the correct report is displayed

New account

Create a new account
Verify the correct report is displayed

Other platforms

Log in to the account
Verify that the app works

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console
Do the above steps

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

kosmydel · 2024-07-08T10:02:52Z

src/libs/ReportUtils.ts

-    return adminReport ?? sortedReports.at(-1);
+    // We are getting the last read report from the metadata of the report.
+    const lastRead = lodashMaxBy(filteredReports, (a) =>
+        new Date(reportMetadata?.[`${ONYXKEYS.COLLECTION.REPORT_METADATA}${a?.reportID}`]?.lastVisitTime ?? a?.lastReadTime ?? '').valueOf(),


If we are 100% certain that the lastReadTime format will always be the same (2024-07-08 08:55:01.665), we can avoid parsing it into the Date object, as it is slow.

cc @mountiny

However, if there is a chance that the format might change, it is safer to leave it as it is.

This change will probably have a minor performance boost, as the process is now O(n) and will only be called once, and only if the reportID is not in the URL.

Constructing Date shouldn't have a big impact on the performance 🤔 Can you verify if it really affects the speed?

Right now the difference is minor, but when we sorted the whole array, it had a significant impact overall.

Comparison main branch

Date 0.51 ms 0.12 ms

string 0.23 ms 0.09 ms

Less time: 55.41% 25.37%

Let's verify if the format is always the same, it might be worth not using Date. Thank you for providing the benchmark 😄

I think the format should be the same always, but I think we can make that change in a follow up PR just to make sure we can easily catch any regressions

melvin-bot · 2024-07-08T12:24:28Z

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

ikevin127 · 2024-07-08T20:25:06Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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.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(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.
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: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari *

web.mov

MacOS: Desktop

ikevin127

LGTM and tests well in all cases! 🚀

mountiny

@kosmydel One comment only to rename the method and you got ocnfclits, please ping me in slack when you resolve so we can merge

src/libs/ReportUtils.ts

mountiny

Thank you

OSBotify · 2024-07-10T09:05:40Z

✋ 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 · 2024-07-10T11:20:53Z

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

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

OSBotify · 2024-07-10T11:38:07Z

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

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

OSBotify · 2024-07-11T10:18:22Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-11T10:37:58Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-15T20:26:47Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

OSBotify · 2024-07-17T00:21:37Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

allroundexperts · 2024-08-12T14:12:41Z

src/libs/ReportUtils.ts

+    const filteredReports = reports.filter(
+        (report) => !!report?.reportID && !!(reportMetadata?.[`${ONYXKEYS.COLLECTION.REPORT_METADATA}${report.reportID}`]?.lastVisitTime ?? report?.lastReadTime),


We should have added a filter to exclude the left chat reports as well. This later caused #46085

perf: remove sorting from findLastAccessedReport

4bec514

kosmydel commented Jul 8, 2024

View reviewed changes

kosmydel changed the title ~~perf: remove sorting from findLastAccessedReport~~ perf: remove sorting from findLastAccessedReport Jul 8, 2024

fix tests

87c521d

BrtqKr approved these changes Jul 8, 2024

View reviewed changes

blazejkustra approved these changes Jul 8, 2024

View reviewed changes

mountiny assigned kosmydel Jul 8, 2024

mountiny self-requested a review July 8, 2024 11:08

kosmydel marked this pull request as ready for review July 8, 2024 12:24

kosmydel requested a review from a team as a code owner July 8, 2024 12:24

melvin-bot bot requested review from ikevin127 and removed request for a team July 8, 2024 12:24

ikevin127 approved these changes Jul 8, 2024

View reviewed changes

mountiny reviewed Jul 9, 2024

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

kosmydel added 2 commits July 10, 2024 09:15

Merge branch 'main' into @kosmydel/perf/fix-useLastAccessedReportID

fa901f2

rename to getMostRecentlyVisitedReport

a09c322

mountiny approved these changes Jul 10, 2024

View reviewed changes

mountiny merged commit 8ee4c92 into Expensify:main Jul 10, 2024
14 checks passed

github-actions bot mentioned this pull request Jul 10, 2024

Deploy Checklist: New Expensify 2024-07-10 #45144

Closed

kavimuru mentioned this pull request Jul 10, 2024

perf: remove useLastAccessedReportID hook and call findLastAccessedReport only when needed #44955

Merged

50 tasks

ikevin127 mentioned this pull request Jul 15, 2024

[HOLD for Payment 2024-07-22] [$250] Improve ReportScreen rendering time #44925

Closed

allroundexperts reviewed Aug 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf: remove sorting from `findLastAccessedReport` #44948

perf: remove sorting from `findLastAccessedReport` #44948

kosmydel commented Jul 8, 2024 •

edited

Loading

kosmydel Jul 8, 2024

kosmydel Jul 8, 2024

blazejkustra Jul 8, 2024

kosmydel Jul 8, 2024

blazejkustra Jul 8, 2024

mountiny Jul 8, 2024

melvin-bot bot commented Jul 8, 2024

ikevin127 commented Jul 8, 2024 •

edited

Loading

ikevin127 left a comment

mountiny left a comment

mountiny left a comment

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

allroundexperts Aug 12, 2024

Comparison	`main`	`branch`
`Date`	0.51 ms	0.12 ms
`string`	0.23 ms	0.09 ms
Less time:	55.41%	25.37%

		const filteredReports = reports.filter(
		(report) => !!report?.reportID && !!(reportMetadata?.[`${ONYXKEYS.COLLECTION.REPORT_METADATA}${report.reportID}`]?.lastVisitTime ?? report?.lastReadTime),

perf: remove sorting from findLastAccessedReport #44948

perf: remove sorting from findLastAccessedReport #44948

Conversation

kosmydel commented Jul 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Web:

Other platforms

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kosmydel Jul 8, 2024

Choose a reason for hiding this comment

kosmydel Jul 8, 2024

Choose a reason for hiding this comment

blazejkustra Jul 8, 2024

Choose a reason for hiding this comment

kosmydel Jul 8, 2024

Choose a reason for hiding this comment

blazejkustra Jul 8, 2024

Choose a reason for hiding this comment

mountiny Jul 8, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Jul 8, 2024

ikevin127 commented Jul 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ikevin127 left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

allroundexperts Aug 12, 2024

Choose a reason for hiding this comment

perf: remove sorting from `findLastAccessedReport` #44948

perf: remove sorting from `findLastAccessedReport` #44948

kosmydel commented Jul 8, 2024 •

edited

Loading

ikevin127 commented Jul 8, 2024 •

edited

Loading