Performance: Onyx new storage wrapper (idk-keyval) #25565

hannojg · 2023-08-21T09:42:45Z

Details

This is a performance improvement, where we remove the old storage wrapper local forage with idb-keyval which for Onyx.mergeCollection provides up to 100% faster results due to running the changes in one database transaction.

Details can be found here:

Perf: use idb-keyval react-native-onyx#293

Fixed Issues

$ #25566

Tests

Play around in the app, no specific test steps

Verify that no errors appear in the JS console

Offline tests

Play around in the app, no specific test steps

QA Steps

Play around in the app, no specific test 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

melvin-bot · 2023-08-21T09:43:20Z

@flodnv 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-08-21T09:49:07Z

Triggering the build

hannojg · 2023-08-21T10:05:36Z

Whoops, let's wait before we merge! Need to remove the local forage dependency as it isn't used anymore 😅 👍

mountiny · 2023-08-21T10:11:04Z

https://25565.pr-testing.expensify.com/ Web build should be ready here 🚀

mountiny · 2023-08-21T10:38:22Z

Builds are ready @situchan are you able to make this your priority for today and test and see if there are any issues with this?

situchan · 2023-08-21T13:53:06Z

Tests well so far on web. Still testing on all platforms

situchan · 2023-08-21T18:33:36Z

I haven't noticed any regressions yet but how to measure noticeable performance improvement?

marcaaron · 2023-08-22T01:16:58Z

how to measure noticeable performance improvement

We can give the adhoc link to some guides to A/B and see if it improves their startup time cc @sakluger

https://25565.pr-testing.expensify.com/

mountiny · 2023-08-23T10:53:33Z

@hannojg There is a regression here that the LHN is always refreshing when you put the app to background and come back/ switch tabs. Would you be able to look into that?

situchan · 2023-08-23T10:55:54Z

@hannojg There is a regression here that the LHN is always refreshing when you put the app to background and come back/ switch tabs. Would you be able to look into that?

I remember this already happens on production, not caused by this PR

mountiny · 2023-08-23T12:55:34Z

@situchan I cannot repro on staging but I can on the branch build

mountiny · 2023-08-23T13:00:17Z

It could be happening on main tho, in which case its not related to this PR for sure @situchan any chance you could help us confirm that?

situchan · 2023-08-23T14:08:45Z

@situchan I cannot repro on staging but I can on the branch build

on which platform did you reproduce?

mountiny · 2023-08-23T15:14:23Z

on which platform did you reproduce?

web

marcaaron · 2023-08-24T04:00:08Z

I think it's the same thing we already saw when approving and merging this PR? #25426 (comment)

marcaaron · 2023-08-24T04:01:59Z

Sorry wrong comment link. This is the right one here

situchan · 2023-08-24T10:58:12Z

I think it's the same thing we already saw when approving and merging this PR?

yes, correct but I thought @mountiny was pointing to a different bug which always happens without needing to re-login?

mountiny · 2023-08-24T13:25:51Z

was pointing to a different bug which always happens without needing to re-login?

What we saw was happening just on putting the app to background and foreground, maybe we can make a new build here

mountiny · 2023-08-24T13:34:36Z

@situchan lets see if we can merge this one

mountiny · 2023-08-24T14:00:04Z

I have tested the web and ios and it seems fine except the LHN refreshing on native ios when I put the app to background and open it again. You can see it at the end of the ios video
https://github.com/Expensify/App/assets/36083550/b34f8930-b179-446e-8025-26ef53b78b46

RPReplay_Final16928854192.mp4

…ew-storage-wrapper

mountiny · 2023-08-24T14:51:49Z

I cannot reproduce in a simulator, I am inclined towards going ahead

mountiny · 2023-08-24T14:52:28Z

Maybe its a problem with the adhoc build, if this will be repro in staging after deploy, then we have a culprit at least

situchan · 2023-08-24T14:53:45Z

ok going ahead checklist

mountiny · 2023-08-24T15:05:20Z

@situchan appreciated

OSBotify · 2023-08-24T15:18:23Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/25565/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/25565/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/25565/NewExpensify.dmg	https://25565.pr-testing.expensify.com

mountiny · 2023-08-24T16:03:01Z

I dont see it anymore

situchan · 2023-08-24T16:03:42Z

I dont see it anymore

Good news

situchan · 2023-08-24T18:40:03Z

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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mov

Android

android.mov

marcaaron · 2023-08-24T21:55:26Z

I'm gonna push this one forward so we can get it onto staging sooner vs. later. Sounds like there are some other improvements to get to after this! 🚀

OSBotify · 2023-08-24T22:03:48Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

sakluger · 2023-08-26T00:44:03Z

I'll test again as well once this is deployed to staging to make sure the LHN refresh bug is not happening anymore.

OSBotify · 2023-08-28T18:50:17Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.58-0 🚀

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

OSBotify · 2023-08-30T01:19:20Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

OSBotify · 2023-08-30T01:57:45Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.59-0 🚀

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

OSBotify · 2023-08-31T01:58:03Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

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

abdulrahuman5196 · 2023-10-09T17:58:24Z

This PR caused an issue of login failure when we use magic link on a different tab - #26190 (comment)

Onyx pump: web new storage wrapper

d855ef9

hannojg requested a review from a team as a code owner August 21, 2023 09:42

melvin-bot bot requested review from flodnv and removed request for a team August 21, 2023 09:43

mountiny assigned hannojg Aug 21, 2023

mountiny added the Ready To Build label Aug 21, 2023

mountiny self-requested a review August 21, 2023 09:49

flodnv previously approved these changes Aug 21, 2023

View reviewed changes

mountiny requested a review from situchan August 21, 2023 10:11

remove obsolete localforage pacakge

72506e3

hannojg dismissed flodnv’s stale review via 72506e3 August 21, 2023 10:18

marcaaron mentioned this pull request Aug 22, 2023

Update Onyx to 1.0.64. Addresses app breaking when storage runs out. #25639

Closed

60 tasks

Merge branch 'main' of github.com:Expensify/App into perf/onyx-pump-n…

64f335f

…ew-storage-wrapper

situchan approved these changes Aug 24, 2023

View reviewed changes

marcaaron approved these changes Aug 24, 2023

View reviewed changes

marcaaron merged commit ef53336 into Expensify:main Aug 24, 2023
13 checks passed

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

luacmartins mentioned this pull request Aug 29, 2023

[HOLD for payment 2023-10-09] [$500] Login - Abracadabra/2FA page displays but user can't login/continue until page is reloaded #26190

Closed

6 tasks

OSBotify mentioned this pull request Aug 30, 2023

Deploy Checklist: New Expensify 2023-08-30 #26268

Closed

melvin-bot bot mentioned this pull request Aug 30, 2023

[HOLD for payment 2023-09-06] Use idb-keyval in Onyx #25566

Closed

Performance: Onyx new storage wrapper (idk-keyval) #25565

Performance: Onyx new storage wrapper (idk-keyval) #25565

Conversation

hannojg commented Aug 21, 2023 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 21, 2023

mountiny commented Aug 21, 2023

hannojg commented Aug 21, 2023

mountiny commented Aug 21, 2023

mountiny commented Aug 21, 2023

situchan commented Aug 21, 2023

situchan commented Aug 21, 2023

marcaaron commented Aug 22, 2023

mountiny commented Aug 23, 2023

situchan commented Aug 23, 2023

mountiny commented Aug 23, 2023

mountiny commented Aug 23, 2023

situchan commented Aug 23, 2023

mountiny commented Aug 23, 2023

marcaaron commented Aug 24, 2023

marcaaron commented Aug 24, 2023

situchan commented Aug 24, 2023

mountiny commented Aug 24, 2023

mountiny commented Aug 24, 2023

mountiny commented Aug 24, 2023

mountiny commented Aug 24, 2023

mountiny commented Aug 24, 2023

situchan commented Aug 24, 2023

mountiny commented Aug 24, 2023

OSBotify commented Aug 24, 2023

mountiny commented Aug 24, 2023

situchan commented Aug 24, 2023

situchan commented Aug 24, 2023

Reviewer Checklist

Screenshots/Videos

marcaaron commented Aug 24, 2023

OSBotify commented Aug 24, 2023

sakluger commented Aug 26, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 30, 2023

OSBotify commented Aug 30, 2023

OSBotify commented Aug 31, 2023

abdulrahuman5196 commented Oct 9, 2023

hannojg commented Aug 21, 2023 •

edited by mountiny

Loading