Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

perf: Cache search options #38207

Merged
merged 57 commits into from
Apr 3, 2024
Merged

perf: Cache search options #38207

merged 57 commits into from
Apr 3, 2024

Conversation

TMisiukiewicz
Copy link
Contributor

@TMisiukiewicz TMisiukiewicz commented Mar 13, 2024 •
edited
Loading

Details

This PR introduces performance improvement for loading searchable lists by caching the options and filtering them when accessing the list.

Fixed Issues

$ #37878
PROPOSAL:

Tests

Before each test: close & open or refresh the app, to make sure options are not cached before first opening

Search page:

  1. Open the search page
  2. Verify the list loaded
  3. Close the list
  4. Open it again and make sure it loaded

New chat

  1. Press "Start chat"
  2. Verify the list loaded - it should contain user name/email/phone number
  3. Close the list
  4. Open it again and make sure it loaded

New room chat

  1. Press "Start chat"
  2. Select "Room"
  3. Fill the name and create a room
  4. Open room details
  5. Press "Members"
  6. Press "Invite"
  7. Verity the list loaded with user name/email/phone number
  8. Go back
  9. Press "Invite" again
  10. Verify the list loaded

Request money

  1. Press "Request money"
  2. Select "Manual", fill the amount and press "Next"
  3. Verify the list loaded
  4. Go back and press "Next" again
  5. Verify the list loaded
  6. Select an item to split bill and finish the process of splitting

Send money

  1. Press "Send money"
  2. Fill the amount and press "Next"
  3. Verify the list loaded
  4. Go back and press "Next again"
  5. Verify the list loaded

Assign task

  1. Press "Assign task"
  2. Fill the title and press "Next"
  3. Press "Assignee"
  4. Verify the list loaded with user name/email/phone number
  5. Go back and press "Assignee" again
  6. Verify the list loaded

Assign task - share somewhere

  1. Press "Assign task"
  2. Fill the title and press "Next"
  3. Press "Share somewhere"
  4. Verify the list loaded with reports
  5. Go back and press "Share somewhere" again
  6. Verify the list loaded

Invite to workspace

  1. Open "Choose a workspace"
  2. Press "+" button
  3. Go to "Members"
  4. Press "Invite member"
  5. Verify the list loaded with user name/email/phone number
  6. Go back and press "Invite member" again
  7. Verify the list loaded again
  8. Select an user and press "Next"
  9. Verify you were moved to another step

Share logs

  1. Go to Settings -> About -> Troubleshoot
  2. Enable "Client Side logging"
  3. Press "Debug console"
  4. Press "Share log"
  5. Verify the list is visible
  6. Go back and press "Share log" again
  7. Verify the list is visible
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Before each test: close & open or refresh the app, to make sure options are not cached before first opening

Search page:

  1. Open the search page
  2. Verify the list loaded
  3. Close the list
  4. Open it again and make sure it loaded

New chat

  1. Press "Start chat"
  2. Verify the list loaded - it should contain user name/email/phone number
  3. Close the list
  4. Open it again and make sure it loaded

New room chat

  1. Press "Start chat"
  2. Select "Room"
  3. Fill the name and create a room
  4. Open room details
  5. Press "Members"
  6. Press "Invite"
  7. Verity the list loaded with user name/email/phone number
  8. Go back
  9. Press "Invite" again
  10. Verify the list loaded

Request money

  1. Press "Request money"
  2. Select "Manual", fill the amount and press "Next"
  3. Verify the list loaded
  4. Go back and press "Next" again
  5. Verify the list loaded
  6. Select an item to split bill and finish the process of splitting

Send money

  1. Press "Send money"
  2. Fill the amount and press "Next"
  3. Verify the list loaded
  4. Go back and press "Next again"
  5. Verify the list loaded

Assign task

  1. Press "Assign task"
  2. Fill the title and press "Next"
  3. Press "Assignee"
  4. Verify the list loaded with user name/email/phone number
  5. Go back and press "Assignee" again
  6. Verify the list loaded

Assign task - share somewhere

  1. Press "Assign task"
  2. Fill the title and press "Next"
  3. Press "Share somewhere"
  4. Verify the list loaded with reports
  5. Go back and press "Share somewhere" again
  6. Verify the list loaded

Invite to workspace

  1. Open "Choose a workspace"
  2. Press "+" button
  3. Go to "Members"
  4. Press "Invite member"
  5. Verify the list loaded with user name/email/phone number
  6. Go back and press "Invite member" again
  7. Verify the list loaded again
  8. Select an user and press "Next"
  9. Verify you were moved to another step

Share logs

  1. Go to Settings -> About -> Troubleshoot
  2. Enable "Client Side logging"
  3. Press "Debug console"
  4. Press "Share log"
  5. Verify the list is visible
  6. Go back and press "Share log" again
  7. Verify the list is visible
  • 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
    • 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 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.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 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.

Screenshots/Videos

Android: Native
new.chat.mov
request.money.mov
room.members.mov
assign.task.mov
invite.workspace.mov
share.logs.mov
share.somewhere.mov
send.money.mov
search.mov
Android: mWeb Chrome
new.chat.mov
request.money.mov
chat.room.mov
assign.task.mov
invite.workspace.mov
share.logs.mov
share.somewhere.mov
send.money.mov
search.mov
iOS: Native
search.mp4
room.chat.mp4
request.money.mp4
send.money.mp4
assign.task.mp4
share.somewhere.mp4
invite.workspace.mp4
start.chat.mp4
iOS: mWeb Safari
search.mp4
request.money.mp4
send.money.mp4
assign.to.task.mp4
share.somewhere.mp4
invite.workspace.mp4
share.log.mp4
room.chat.mp4
start.chat.mp4
MacOS: Chrome / Safari
request.money.mov
assign.task.mov
invite.member.mov
room.chat.mov
share.log.mov
share.somewehere.mov
send.money.mov
search.mov
MacOS: Desktop
room.chat.mov
request.money.mov
assign.task.mov
invite.mov
share.log.mov
share.somewhere.mov
send.money.mov
start.chat.mov
search.mov

@TMisiukiewicz
add function to create all reports and personal details options
840ac30
@TMisiukiewicz
use context to initialize all options
68e364c
@TMisiukiewicz
update getOptions, use options generation in search
d32dd3a
@TMisiukiewicz
Merge branch 'main' into perf/cache-options
addd702
@TMisiukiewicz
update usage in search page
50c823c
@TMisiukiewicz
update options list utils
2c7d231
@TMisiukiewicz
create reusable initializer for search pages
b1bd11f
@TMisiukiewicz
add options to new chat page
499eb84
@TMisiukiewicz
update other occurencies of getoptions
122a6fb
@TMisiukiewicz
update initializing in search page
4c0cb3e
@TMisiukiewicz
update types for options
0a7925e
@TMisiukiewicz
Merge branch 'main' into perf/cache-options
2eb21a1
@TMisiukiewicz
update loading in search page
47795b9
@TMisiukiewicz
update new chat page skeleton displaying
ffaee2a
@TMisiukiewicz
update caching in all selection lists
47fc679
@TMisiukiewicz
update options in the background
623810f
@TMisiukiewicz
Merge remote-tracking branch 'upstream/main' into perf/cache-options
ef90c70
@TMisiukiewicz
update changed personal details
d4621e9
@TMisiukiewicz
fix loader on new chat page
653c9cb
@TMisiukiewicz
filter personal details with login
d75cc3f
@TMisiukiewicz
generate alternate text on the fly if needed
7ad2872
@TMisiukiewicz
freeze the option list when search is open
67a0ae2
@kavimuru kavimuru mentioned this pull request Mar 14, 2024
Closed
74 tasks
@grgia
Copy link
Contributor

grgia commented Apr 2, 2024

Triggering a test build

@github-actions GitHub Actions

This comment was marked as outdated.

Sign in to view
@grgia
Copy link
Contributor

grgia commented Apr 2, 2024

Rerunning desktop

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 2, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/38207/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/38207/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/38207/NewExpensify.dmg https://38207.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

grgia
grgia previously approved these changes Apr 2, 2024
View reviewed changes
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

LGTM and tests well, a few NAB comments

src/libs/OptionsListUtils.ts Outdated Show resolved Hide resolved
src/libs/OptionsListUtils.ts Show resolved Hide resolved
src/libs/ReportUtils.ts
let lastUpdatedReport: OnyxEntry<Report>;

Onyx.connect({
key: ONYXKEYS.COLLECTION.REPORT,
Copy link
Contributor

Choose a reason for hiding this comment

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

should we address this given the linked PR was merged? @hungvu193

@TMisiukiewicz
Copy link
Contributor Author

Resolved conflicts and addressed the comments.

grgia
grgia approved these changes Apr 3, 2024
View reviewed changes
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

Nice work on this

@grgia grgia merged commit 398636a into Expensify:main Apr 3, 2024
16 of 17 checks passed
@grgia
Copy link
Contributor

grgia commented Apr 3, 2024

See: #38207 (comment) for why the merge with failing test

@OSBotify
Copy link
Contributor

OSBotify commented Apr 3, 2024

✋ 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 github-actions bot mentioned this pull request Apr 4, 2024
Closed
44 tasks
@mountiny mountiny mentioned this pull request Apr 4, 2024
Closed
48 tasks
@brunovjk brunovjk mentioned this pull request Apr 4, 2024
Closed
6 tasks
@bondydaa
Copy link
Contributor

bondydaa commented Apr 4, 2024

@mountiny was this PR actually deployed? I see you linked in the Deploy Checklist but that last comment here confuses me.

@bondydaa bondydaa mentioned this pull request Apr 4, 2024
Closed
6 tasks
@bondydaa
Copy link
Contributor

bondydaa commented Apr 4, 2024

i'm pretty sure it's deployed and causing this deploy blocker, already tagged everyone on it but if you're still around and can lend a hand please do #39607

@mountiny
Copy link
Contributor

mountiny commented Apr 4, 2024

@bondydaa Yes it was deployed, the github action to post comment has also been broken 😵‍💫

This was referenced Apr 5, 2024
Closed
Closed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

paultsimura
paultsimura reviewed Apr 13, 2024
View reviewed changes
src/App.tsx
@@ -82,6 +83,7 @@ function App({url}: AppProps) {
FullScreenContextProvider,
VolumeContextProvider,
VideoPopoverMenuContextProvider,
OptionsListContextProvider,
Copy link
Contributor

Choose a reason for hiding this comment

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

Placing this context provider here caused #39710 – we needed to move it inside AuthScreens so that it would be destroyed each time the user logs out.

@rojiphil rojiphil mentioned this pull request Apr 19, 2024
Closed
58 tasks
@jjcoffee jjcoffee mentioned this pull request May 20, 2024
Closed
6 tasks
jjcoffee
jjcoffee reviewed May 20, 2024
View reviewed changes
src/components/OptionListContextProvider.tsx
});
const personalDetails = usePersonalDetails();

useEffect(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #40493, we missed updating the cache when a report is deleted.

@bernhardoj bernhardoj mentioned this pull request May 24, 2024
Closed
6 tasks
@c3024 c3024 mentioned this pull request Jun 4, 2024
Closed
6 tasks
@TMisiukiewicz TMisiukiewicz mentioned this pull request Jul 31, 2024
Merged
50 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jjcoffee jjcoffee jjcoffee left review comments

@hungvu193 hungvu193 hungvu193 approved these changes

@paultsimura paultsimura paultsimura left review comments

@grgia grgia grgia approved these changes

Assignees

@TMisiukiewicz TMisiukiewicz

Labels
Ready To Build
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@TMisiukiewicz @mountiny @hungvu193 @grgia @OSBotify @bondydaa @paultsimura @jjcoffee