feat: Import onyx state

[TMisiukiewicz]

Details

This PR adds "Import onyx state" feature, making it possible to load other user account state in an offline mode in order to track and fix hardly reproducible bugs/track performance improvements.

Fixed Issues

$ #47786
PROPOSAL:

Tests

1. Go to Settings -> Troubleshoot and Export Onyx State
2. Log out from the account
3. Log into another account
4. Go to Settings -> Troubleshoot
5. Press "Import Onyx State"
6. Select the file exported from another account
7. Wait for the onyx state to load
8. Verify the red button saying the state is imported is displayed
9. Verify app is in offline mode
10. Navigate to a few screens and verify app is usable
11. Press the red button
12. Verify the account is back online and is using the Onyx state from the original account

• Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

1. Go to Settings -> Troubleshoot and Export Onyx State
2. Log out from the account
3. Log into another account
4. Go to Settings -> Troubleshoot
5. Press "Import Onyx State"
6. Select the file exported from another account
7. Wait for the onyx state to load
8. Verify the red button saying the state is imported is displayed
9. Verify app is in offline mode
10. Navigate to a few screens and verify app is usable
11. Press the red button
12. Verify the account is back online and is using the Onyx state from the original account

• 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

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[DylanDylann]

@TMisiukiewicz Great job 💯

[rlinoz]

This is a really nice feature, thanks for working on it!

I have a couple of questions:

1. Should I be able to see the reports? Everytime I open then in the imported state I get a Uh-oh, something went wrong!
2. Should we turn off the import mode if the user turns off offline mode as well?

[rlinoz]

I think it would make sense to export betas as well, since having or not having a beta may be the source of a bug, was this discussed somewhere?

[TMisiukiewicz]

can betas differ across different accounts? If yes, let's definitely import them.

I was checking it on a few accounts of mine and each one of them had the same array of betas, that's why my initial thought was that it's safe to omit it

[rlinoz]

Ah right, it can definitely be different sometimes

[TMisiukiewicz]

@rlinoz

Should I be able to see the reports? Everytime I open then in the imported state I get a Uh-oh, something went wrong!

yes, you should be able to see those that are stored in the exported state, the app should not crash so it looks like some kind of an edge case we haven't stumbled upon earlier 🤔 could you share the file you are importing so I can take a look?

Should we turn off the import mode if the user turns off offline mode as well?

yeah that's a good idea, I'll implement it 👍

[TMisiukiewicz]

@rlinoz I'm having second thoughts about "Force offline", WDYT about simply disabling the switch when using imported state? I feel like the switch should be responsible only for a single action, without any side effects 🤔

[rlinoz]

Yeah, I like the idea of disabling it, let's do it! We can improve later in case it gets confusing.

Here is the file:
onyx-state(2).txt

[TMisiukiewicz]

@rlinoz thank you! Could you please export onyx state one more time and try to import it? Seems like there was some unexpected data transformation happening while exporting state with masked fragile data. I also disabled the "Force offline" switch as mentioned above and removed betas from preserved keys

[DylanDylann]

@rlinoz Could you please help to export your Onyx file again? I retest with some accounts and It works well

[github-actions]

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

Android 🤖	iOS 🍎
❌ FAILED ❌	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49255/index.html
The QR code can't be generated, because the android build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49255/NewExpensify.dmg	https://49255.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[rlinoz]

Before I test on the build above let me explain what is happening in a dev account that I have

Something is null in my keys but this line that isn't changed in this PR evaluates null as object and pass it on causing the crash.

Now, I don't know if this is some weird state that I am in because it is a dev account or something else, I will try on the build above with staging accounts now.

[rlinoz]

Yeah, same thing happens in the build above with an existing account that I have, if I create a new one it works fine

[TMisiukiewicz]

@rlinoz I couldn't reproduce that but i added an additional check for null value when exporting state, mind checking again?

[rlinoz]

Working great, thanks!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.0.45-1 🚀

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

[github-actions]

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.45-4 🚀

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