fix: Import Onyx state on iOS #53370

TMisiukiewicz · 2024-12-02T10:13:37Z

Explanation of Change

The library used for reading files in Import Onyx State is not maintained anymore, so we needed to change the way we read it. We replaced its usage with React Native Blob Util filesystem method.

Fixed Issues

$ #53060
PROPOSAL: #53060 (comment)

Tests

Should be tested on iOS and Android only.

Go to Settings -> Troubleshoot
Export Onyx state
Log into another account
Go to Settings -> Troubleshoot
Press "Import Onyx State"
Select a file that was downloaded previously
Verify the file is uploaded and you are navigated to home screen in offline mode

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Same as tests

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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-import.mov

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-12-02T10:13:42Z

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

eVoloshchak · 2024-12-04T18:49:13Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2024-12-10.at.10.37.13.mov

iOS: Native

Screen.Recording.2024-12-10.at.10.18.10.mov

eVoloshchak · 2024-12-04T18:56:41Z

src/components/ImportOnyxState/index.native.tsx

-                return fileContent;
-            });
-        });
+    return ReactNativeBlobUtil.fs.exists(filePath).then((exists) => {


@TMisiukiewicz, have you considered using readStream instead of readFile?
According to the docs:

if the file is large, you should consider use readStream instead.

And since log files could realistically be large, we might hit a limit

Yes, this was my initial idea. However, when using it, the app was crashing immediately without any JS error. I found out during debugging with Xcode that this is the error that makes it crash:

*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '*** -[__NSPlaceholderDictionary initWithObjects:forKeys:count:]: attempt to insert nil object from objects[0]'

I couldn't find any information how to fix it. I found out that this was reported in the library repository here: RonRadtke/react-native-blob-util#392 but thought the fastest way to unblock me from doing other fixes related to Import is using readFile. Works for me with ~15mb files. Maybe it's a good idea to go with this solution first and eventually adjust it once we hit any issues?

Maybe it's a good idea to go with this solution first and eventually adjust it once we hit any issues?

Can confirm, this works for large files on my end too. Agree, let's proceed with the current solution, we can follow-up in case any problems arise

eVoloshchak · 2024-12-05T20:54:15Z

A newly added PR checklist item requires us to have unit tests implemented for any new fix/feature

For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.

Is there a way a unit test could be implemented for this?

TMisiukiewicz · 2024-12-06T07:38:44Z

@eVoloshchak yeah I was thinking about it when opening a PR, and in my opinion it's very difficult to write a good test here. The only thing we'd be able to do is mocking react-native-blob-util and testing if it calls the readFile function. So it doesn't test the behavior I fixed, and additionally it tests the implementation details, which is an anti-pattern when it comes to testing.

adhorodyski · 2024-12-06T09:12:17Z

I'd say a good test overall for this whole import feature is that it just doesn't break the app - so the app should be tested with regular units in the first place, where needed (within the features). Import itself should only override load data from the file. Masking confidential pieces is already tested as part of the Export functionality.

eVoloshchak

LGTM!

OSBotify · 2024-12-10T11:17:46Z

✋ 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 · 2024-12-10T23:03:42Z

🚀 Deployed to staging by https://github.com/Gonals in version: 9.0.74-0 🚀

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

github-actions · 2024-12-12T01:33:39Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.74-8 🚀

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

read Onyx state using react native blob util

1e9b731

TMisiukiewicz requested a review from a team as a code owner December 2, 2024 10:13

melvin-bot bot requested review from eVoloshchak and removed request for a team December 2, 2024 10:13

TMisiukiewicz mentioned this pull request Dec 2, 2024

fix: display all LHN options in Import state mode #53374

Merged

50 tasks

eVoloshchak reviewed Dec 4, 2024

View reviewed changes

Merge branch 'main' into fix/import-onyx-state-on-ios

337361c

eVoloshchak approved these changes Dec 10, 2024

View reviewed changes

melvin-bot bot requested a review from Gonals December 10, 2024 09:38

Gonals approved these changes Dec 10, 2024

View reviewed changes

Gonals merged commit 7f2c689 into Expensify:main Dec 10, 2024
17 of 18 checks passed

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

Deploy Checklist: New Expensify 2024-12-10 #53889

Closed

52 tasks

melvin-bot bot mentioned this pull request Dec 12, 2024

[HOLD for payment 2024-12-25] [HOLD for payment 2024-12-19] Import & Export Onyx state reliability issues #53060

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Import Onyx state on iOS #53370

fix: Import Onyx state on iOS #53370

TMisiukiewicz commented Dec 2, 2024

melvin-bot bot commented Dec 2, 2024

eVoloshchak commented Dec 4, 2024 •

edited

Loading

eVoloshchak Dec 4, 2024

TMisiukiewicz Dec 5, 2024

eVoloshchak Dec 5, 2024

eVoloshchak commented Dec 5, 2024

TMisiukiewicz commented Dec 6, 2024

adhorodyski commented Dec 6, 2024 •

edited

Loading

eVoloshchak left a comment

OSBotify commented Dec 10, 2024

github-actions bot commented Dec 10, 2024

github-actions bot commented Dec 12, 2024

fix: Import Onyx state on iOS #53370

fix: Import Onyx state on iOS #53370

Conversation

TMisiukiewicz commented Dec 2, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 2, 2024

eVoloshchak commented Dec 4, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak Dec 4, 2024

Choose a reason for hiding this comment

TMisiukiewicz Dec 5, 2024

Choose a reason for hiding this comment

eVoloshchak Dec 5, 2024

Choose a reason for hiding this comment

eVoloshchak commented Dec 5, 2024

TMisiukiewicz commented Dec 6, 2024

adhorodyski commented Dec 6, 2024 • edited Loading

eVoloshchak left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 10, 2024

github-actions bot commented Dec 10, 2024

github-actions bot commented Dec 12, 2024

eVoloshchak commented Dec 4, 2024 •

edited

Loading

adhorodyski commented Dec 6, 2024 •

edited

Loading