Feature/43097 - "Export onyx state" button in the troubleshoot section #43552

burczu · 2024-06-12T11:56:51Z

Details

This PR implements the new "Export Onyx state" functionality that adds new button in the "Troubleshoot" section that exports the current Onyx state object as a TXT file.

Fixed Issues

$ #43097
PROPOSAL: #43097 (comment)

Tests

Log in to the App
Navigate to Accout Settings -> Troubleshoot section
Press the "Export Onyx state" button
Wait for the file to be generated and saved (you may be asked to decide where to save the file)
Check the content of the saved file (it should contain the Onyx state as a string with emails and authTokens masked by "***" string)

Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Same as above.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-06-19.at.12.38.38.mov

Android: mWeb Chrome

Screen.Recording.2024-06-19.at.12.01.12.mov

iOS: Native

Screen.Recording.2024-06-19.at.11.54.39.mov

iOS: mWeb Safari

Screen.Recording.2024-06-19.at.11.16.32.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-19.at.11.12.55.mov

MacOS: Desktop

Screen.Recording.2024-06-19.at.11.15.25.mov

…o account

melvin-bot · 2024-06-19T10:40:25Z

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

ZhenjaHorbach · 2024-06-27T13:20:38Z

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.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ZhenjaHorbach · 2024-06-27T14:24:52Z

@burczu
Can you please check desktop app ?
I have an error

2024-06-27.16.24.16.mov

src/pages/settings/Troubleshoot/TroubleshootPage.tsx

src/libs/ExportOnyxState/index.native.ts

burczu · 2024-06-28T10:24:25Z

Hey @ZhenjaHorbach!

I've checked the desktop app and it looks ok on my end:

Screen.Recording.2024-06-28.at.12.22.13.mov

Maybe it's something with the state of your project? I've just synced it with the latest main - please check if it helps, maybe?

ZhenjaHorbach · 2024-06-28T14:58:26Z

Hey @ZhenjaHorbach!

I've checked the desktop app and it looks ok on my end:

Screen.Recording.2024-06-28.at.12.22.13.mov
Maybe it's something with the state of your project? I've just synced it with the latest main - please check if it helps, maybe?

Oh
Yes
Now everything works
And thanks for fix the comments

@burczu
But could you also fix eslint issues?

ZhenjaHorbach · 2024-06-28T15:33:36Z

Very strange
Same error only for iOS web

ZhenjaHorbach · 2024-06-28T15:39:18Z

We have cases where maskFragileData receives null as data

https://github.com/Expensify/App/pull/43552/files#diff-972f42b08616a0b8667e9576f3d01fd3ade2e0f6ec42d67216a006d8f803617aR4

I think we need to add a check for these cases

burczu · 2024-07-01T07:39:35Z

@ZhenjaHorbach fixed eslint errors + added the check for null data. I hope this fixes all the issues.

ZhenjaHorbach · 2024-07-01T09:37:03Z

@burczu

Everything works fine now, thanks
The only thing I noticed is when we open share modal on Android
And close it
We receive a warning

burczu · 2024-07-01T10:00:05Z

@ZhenjaHorbach I've added failOnCancel set to false option of Share.open call - it should fix this last issue. Thanks for pointing this out.

ZhenjaHorbach · 2024-07-01T10:05:46Z

@ZhenjaHorbach I've added failOnCancel set to false option of Share.open call - it should fix this last issue. Thanks for pointing this out.

Nice
Great job 😀
The changes look great !

OSBotify · 2024-07-03T14:34:00Z

✋ 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-03T20:00:27Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.4-0 🚀

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

OSBotify · 2024-07-04T22:12:54Z

🚀 Cherry-picked to staging by https://github.com/tgolen in version: 9.0.4-5 🚀

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-10T10:55:47Z

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

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

OSBotify · 2024-07-15T20:18:44Z

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

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

allgandalf · 2024-07-18T09:17:04Z

src/libs/ExportOnyxState/index.ts

+const readFromOnyxDatabase = () =>
+    new Promise<Record<string, unknown>>((resolve) => {
+        let db: IDBDatabase;
+        const openRequest = indexedDB.open(CONST.DEFAULT_DB_NAME, 1);


We should not have had set the default version for database, this caused #45232. Database version was a optional parameter here.

burczu added 4 commits June 12, 2024 10:38

export onyx state button added

7890b03

fetching onyx store key/value pairs PoC

62ef244

direct access to indexedDB instance possibility added

95e118b

distinction between web and native way of storing Onyx data taken int…

fca2b12

…o account

burczu force-pushed the feature/43097-export-onyx-state branch from 9e8a60e to fca2b12 Compare June 13, 2024 14:01

burczu added 10 commits June 14, 2024 13:24

saving as txt file added

7eed281

masking fragile data added

3005ecc

prettier

ed03efe

common part extracted

4160cc8

useCallback usage added

934346d

Merge branch 'main' into feature/43097-export-onyx-state

927eea5

const values extracted

6c0574d

unnecessary variables removed

56fe0cd

useMemo deps array updated

8423971

additional comment added

673dd59

burczu marked this pull request as ready for review June 19, 2024 10:40

burczu requested a review from a team as a code owner June 19, 2024 10:40

melvin-bot bot requested review from ZhenjaHorbach and removed request for a team June 19, 2024 10:40

filtering report actions out added

e07a5ce

ZhenjaHorbach mentioned this pull request Jun 27, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [$250] [Performance] [MEDIUM] Add "Export Onyx state" option to Troubleshoot menu and four finger tap #43097

Closed

6 tasks

burczu added 3 commits June 27, 2024 10:32

masking messages inside report actions

1acf989

mask wording translation added

37c960f

eslint fixed

d6047e6

ZhenjaHorbach reviewed Jun 27, 2024

View reviewed changes

src/pages/settings/Troubleshoot/TroubleshootPage.tsx Outdated Show resolved Hide resolved

ZhenjaHorbach reviewed Jun 27, 2024

View reviewed changes

src/libs/ExportOnyxState/index.native.ts Outdated Show resolved Hide resolved

member access made safe instead suppressing it

2607bb5

burczu added 2 commits June 28, 2024 12:14

toggling onyx state masking simplified

d1c6567

Merge branch 'main' into feature/43097-export-onyx-state

363ac2d

burczu added 2 commits July 1, 2024 08:44

eslint errors fix

0498474

missing check for null added

9abd735

failing on cancel disabled

6b49c85

ZhenjaHorbach approved these changes Jul 1, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga July 1, 2024 10:05

puneetlath approved these changes Jul 3, 2024

View reviewed changes

puneetlath merged commit 0e4e2d2 into Expensify:main Jul 3, 2024
15 checks passed

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

Deploy Checklist: New Expensify 2024-07-03 #44782

Closed

kavimuru mentioned this pull request Jul 4, 2024

[HOLD for payment 2024-07-25] Troubleshoot-"Mask fragile user data while exporting Onyx state" toggle is auto-enabled #44841

Closed

6 tasks

allgandalf reviewed Jul 18, 2024

View reviewed changes

allgandalf mentioned this pull request Jul 18, 2024

[HOLD for payment 2024-07-24] Export to Onyx state not working #45232

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/43097 - "Export onyx state" button in the troubleshoot section #43552

Feature/43097 - "Export onyx state" button in the troubleshoot section #43552

burczu commented Jun 12, 2024 •

edited

Loading

melvin-bot bot commented Jun 19, 2024

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

burczu commented Jun 28, 2024

ZhenjaHorbach commented Jun 28, 2024

ZhenjaHorbach commented Jun 28, 2024

ZhenjaHorbach commented Jun 28, 2024

burczu commented Jul 1, 2024

ZhenjaHorbach commented Jul 1, 2024

burczu commented Jul 1, 2024 •

edited

Loading

ZhenjaHorbach commented Jul 1, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 4, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 15, 2024

allgandalf Jul 18, 2024

Feature/43097 - "Export onyx state" button in the troubleshoot section #43552

Feature/43097 - "Export onyx state" button in the troubleshoot section #43552

Conversation

burczu commented Jun 12, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 19, 2024

ZhenjaHorbach commented Jun 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ZhenjaHorbach commented Jun 27, 2024 • edited Loading

burczu commented Jun 28, 2024

ZhenjaHorbach commented Jun 28, 2024

ZhenjaHorbach commented Jun 28, 2024

ZhenjaHorbach commented Jun 28, 2024

burczu commented Jul 1, 2024

ZhenjaHorbach commented Jul 1, 2024

burczu commented Jul 1, 2024 • edited Loading

ZhenjaHorbach commented Jul 1, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 4, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 15, 2024

allgandalf Jul 18, 2024

Choose a reason for hiding this comment

burczu commented Jun 12, 2024 •

edited

Loading

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

burczu commented Jul 1, 2024 •

edited

Loading