feat: Troubleshooting page & resetting Onyx state #35306

TMisiukiewicz · 2024-01-29T11:40:09Z

Details

created new screen "Troubleshoot"
added "Troubleshoot" to "About" menu
added possibility of wiping the Onyx data by pressing "Reset and refresh"
moved "Test Preferences" section to "Troubleshoot" page

The "Console view" will be created as a separate PR.

Fixed Issues

$ #34082
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Go to Profile -> About
Verify "Troubleshoot" is available in the menu
Go to Troubleshoot
Verify "Test preferences" section is visible
Press "Reset and refresh"
Confirm the modal
Go back to home screen
Verify list of chats is visible
If you are on the home screen and the list is not visible yet, wait a moment until it's available (it means data is still loading)

Offline tests

Go offline
Go to Profile -> About -> Troubleshoot
Press "Reset and refresh"
Confirm the modal
Go to home screen and verify skeleton is displayed
Go online
Wait and verify the data is loaded

QA Steps

Verify that no errors appear in the JS console

Go to Profile -> About
Verify "Troubleshoot" is available in the menu
Go to Troubleshoot
Verify "Test preferences" section is visible
Press "Reset and refresh"
Cofirm the modal
Go back to home screen
Verify list of chats is visible
If you are on the home screen and the list is not visible yet, wait a moment until it's available (it means data is still loading)

PR Author Checklist

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

…g-section

src/languages/en.ts

src/languages/es.ts

src/pages/settings/AboutPage/TroubleshootingPage.tsx

TMisiukiewicz · 2024-02-14T08:04:45Z

As discussed here I think we don't need to disable resetting option when offline, so PR is ready

techievivek · 2024-02-14T08:39:18Z

As discussed here I think we don't need to disable resetting option when offline, so PR is ready

So, for offline cases, are we logging out the user? Otherwise, as you have mentioned, this can make the App unusable in offline case, no? So I think we can either find a fix so we don't end up in this situation or have it available only for online users?

TMisiukiewicz · 2024-02-14T08:52:10Z

@techievivek when user is offline, the OpenApp API call goes to the queue and it's executed once user is back online (video here), so I think everything should work as expected once online. User it not logged out, everything is in "loading state", I think this is expected when you are offline

techievivek · 2024-02-14T09:08:37Z

when user is offline, the OpenApp API call goes to the queue and it's executed once user is back online (#35306 (comment))

Ok yeah, I saw the discussion on this, and this request persists in the queue.

User it not logged out, everything is in "loading state", I think this is expected when you are offline

Sounds good and makes sense, thanks. 👍

fedirjh · 2024-02-14T10:30:14Z

@TMisiukiewicz Test preferences section title is missing:

…g-section

fedirjh · 2024-02-14T10:44:51Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

CleanShot.2024-02-14.at.11.58.57.mp4

Android: mWeb Chrome

CleanShot.2024-02-14.at.11.47.47.mp4

iOS: Native

CleanShot.2024-02-14.at.11.39.51.mp4

iOS: mWeb Safari

CleanShot.2024-02-14.at.11.42.38.mp4

MacOS: Chrome / Safari

CleanShot.2024-02-14.at.11.22.51.mp4

MacOS: Desktop

CleanShot.2024-02-14.at.12.06.15.mp4

CleanShot.2024-02-14.at.12.08.11.mp4

TMisiukiewicz · 2024-02-14T10:48:36Z

@fedirjh I went through the file history and found it was removed in #35672 because of the redesign. Brought it back, thanks 👍

fedirjh · 2024-02-14T10:58:48Z

I went through the file history and found it was removed in #35672 because of the redesign

@TMisiukiewicz Interesting. Shouldn’t this page also follow the new redesign? Also, we have a failed test.

TMisiukiewicz · 2024-02-14T11:04:58Z

@fedirjh i can see failing TS check comes from main. Good question about the redesign, @shawnborton could you help us answer this question? I think we could eventually adjust the design to the new one with a separate PR, to not delay merging this one

fedirjh

@techievivek Looks good to me, It's just missing the new design. @TMisiukiewicz has suggested that handle that in a separate PR :

I think we could eventually adjust the design to the new one with a separate PR, to not delay merging this one

techievivek · 2024-02-14T11:37:14Z

Yeah, I agree with it. TS error would be fixed in this PR #36474

techievivek · 2024-02-14T11:42:52Z

@TMisiukiewicz Can you please merge main again, that would fix the typescript error. Thanks

TMisiukiewicz · 2024-02-14T11:56:23Z

@techievivek done 👍

OSBotify · 2024-02-14T12:18: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.

OSBotify · 2024-02-15T05:35:58Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.4.42-0 🚀

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

OSBotify · 2024-02-19T23:34:06Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.42-5 🚀

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

hoangzinh · 2024-03-23T09:24:53Z

Coming from #36645. It's an edge case that we're missing when testing the "Troubleshoot" page

jjcoffee · 2024-09-17T08:09:41Z

src/pages/settings/AboutPage/TroubleshootPage.tsx

+import SCREENS from '@src/SCREENS';
+
+const keysToPreserve: OnyxKey[] = [
+    ONYXKEYS.ACCOUNT,


@TMisiukiewicz Hey, just wondering if there was any specific reason not to include ONYXKEYS.USER here? We're considering adding it in #49087, but wanted to check first if there are any good arguments against doing so.

@jjcoffee some time passed so I don't remember the exact context, but I think adding ONYXKEYS.USER should be fine here

TMisiukiewicz added 21 commits January 23, 2024 08:51

create empty troubleshooting page

d1bf331

move test features from preferences to troubleshooting

8f38e48

build troubleshooting menu

988e1d0

basic implementation of "reset and refresh" option

8da95f5

update copies in troubleshooting section

c9de6f5

update page title

954a6dc

add new lottie animation for troubleshooting screen

192bfee

update background color for troubleshoot page

91c5973

update lottie animation

29d09d5

update type for menu items

a983a2d

update icon for troubleshoot

6fdda4d

update cleared onyx keys when wiping app data

59152dc

wrap clearOnyx with useCallback

89ec5ac

remove console view button

e18404e

update copies

59ac3b3

update list of preserved keys

e2f6d9f

update onyx cleaning method name

cbbfa51

Merge branch 'main' into feat/troubleshooting-section

1c79176

Merge remote-tracking branch 'upstream/main' into feat/troubleshootin…

9ee6198

…g-section

update troubleshoot copies

d9c5ea4

update spanish translations

9656064

TMisiukiewicz mentioned this pull request Jan 31, 2024

[Regression test required] [$500] HIGH: Add Avatar > About > Troubleshooting section #34082

Closed

gedu reviewed Feb 1, 2024

View reviewed changes

src/languages/en.ts Outdated Show resolved Hide resolved

gedu reviewed Feb 1, 2024

View reviewed changes

src/languages/es.ts Outdated Show resolved Hide resolved

gedu reviewed Feb 1, 2024

View reviewed changes

src/pages/settings/AboutPage/TroubleshootingPage.tsx Outdated Show resolved Hide resolved

gedu reviewed Feb 1, 2024

View reviewed changes

src/pages/settings/AboutPage/TroubleshootingPage.tsx Outdated Show resolved Hide resolved

TMisiukiewicz added 3 commits February 1, 2024 11:10

update all keys to "troubleshoot"

07ba7fe

move reset action into menu item

5c155a6

Merge branch 'main' into feat/troubleshooting-section

40a4206

TMisiukiewicz marked this pull request as ready for review February 1, 2024 10:31

Merge remote-tracking branch 'upstream/main' into feat/troubleshootin…

7accc17

…g-section

bring back test tool menu title

4632e28

fedirjh approved these changes Feb 14, 2024

View reviewed changes

melvin-bot bot requested a review from techievivek February 14, 2024 11:32

Merge branch 'main' into feat/troubleshooting-section

319d378

techievivek approved these changes Feb 14, 2024

View reviewed changes

techievivek merged commit 756f846 into Expensify:main Feb 14, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 15, 2024

Deploy Checklist: New Expensify 2024-02-15 #36558

Closed

73 tasks

amyevans mentioned this pull request Feb 15, 2024

[$500] Web - Troubleshoot - Troubleshoot RHP does not open smoothly #36576

Closed

6 tasks

kbecciv mentioned this pull request Feb 15, 2024

Profile - Data is not loaded when go back online after page resetting with “Troubleshooting” #36601

Closed

6 tasks

m-natarajan mentioned this pull request Feb 15, 2024

[HOLD for payment 2024-03-22] [$1000] Settings - Performance and heat issues on the "Troubleshoot" option #36645

Closed

6 tasks

kbecciv mentioned this pull request Feb 16, 2024

[$500] iOS - Settings - A black line appears above the animation #36687

Closed

6 tasks

jjcoffee reviewed Sep 17, 2024

View reviewed changes

jjcoffee mentioned this pull request Sep 20, 2024

[$250] The setting "Mute all sounds from Expensify" keeps turning back off despite turning it on every day. #49087

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Troubleshooting page & resetting Onyx state #35306

feat: Troubleshooting page & resetting Onyx state #35306

TMisiukiewicz commented Jan 29, 2024 •

edited

Loading

TMisiukiewicz commented Feb 14, 2024

techievivek commented Feb 14, 2024

TMisiukiewicz commented Feb 14, 2024 •

edited

Loading

techievivek commented Feb 14, 2024

fedirjh commented Feb 14, 2024

fedirjh commented Feb 14, 2024 •

edited

Loading

TMisiukiewicz commented Feb 14, 2024

fedirjh commented Feb 14, 2024

TMisiukiewicz commented Feb 14, 2024

fedirjh left a comment

techievivek commented Feb 14, 2024

techievivek commented Feb 14, 2024 •

edited

Loading

TMisiukiewicz commented Feb 14, 2024

OSBotify commented Feb 14, 2024

OSBotify commented Feb 15, 2024

OSBotify commented Feb 19, 2024

hoangzinh commented Mar 23, 2024

jjcoffee Sep 17, 2024

TMisiukiewicz Sep 17, 2024

feat: Troubleshooting page & resetting Onyx state #35306

feat: Troubleshooting page & resetting Onyx state #35306

Conversation

TMisiukiewicz commented Jan 29, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

TMisiukiewicz commented Feb 14, 2024

techievivek commented Feb 14, 2024

TMisiukiewicz commented Feb 14, 2024 • edited Loading

techievivek commented Feb 14, 2024

fedirjh commented Feb 14, 2024

fedirjh commented Feb 14, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

TMisiukiewicz commented Feb 14, 2024

fedirjh commented Feb 14, 2024

TMisiukiewicz commented Feb 14, 2024

fedirjh left a comment

Choose a reason for hiding this comment

techievivek commented Feb 14, 2024

techievivek commented Feb 14, 2024 • edited Loading

TMisiukiewicz commented Feb 14, 2024

OSBotify commented Feb 14, 2024

OSBotify commented Feb 15, 2024

OSBotify commented Feb 19, 2024

hoangzinh commented Mar 23, 2024

jjcoffee Sep 17, 2024

Choose a reason for hiding this comment

TMisiukiewicz Sep 17, 2024

Choose a reason for hiding this comment

TMisiukiewicz commented Jan 29, 2024 •

edited

Loading

TMisiukiewicz commented Feb 14, 2024 •

edited

Loading

fedirjh commented Feb 14, 2024 •

edited

Loading

techievivek commented Feb 14, 2024 •

edited

Loading