Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: move "Troubleshoot" out of About #39230

Merged
merged 16 commits into from
Apr 15, 2024
Merged

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Mar 29, 2024

Details

Fixed Issues

$ #38594
PROPOSAL: #38594 (comment)

Tests

  1. Open setting page
  2. Verify that the "Troubleshoot" option is right above the Sign Out option at the bottom.
  3. Click on "Troubleshoot" option
  4. Verify that all features belonging to "Troubleshoot" work well.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open setting page
  2. Verify that the "Troubleshoot" option is right above the Sign Out option at the bottom.
  3. Click on "Troubleshoot" option
  4. Verify that all features belonging to "Troubleshoot" work well.
  • 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
Screen.Recording.2024-03-29.at.18.28.10.mov
Android: mWeb Chrome
Screen.Recording.2024-03-29.at.18.30.36.mov
iOS: Native
Screen.Recording.2024-04-01.at.14.40.37.mov
iOS: mWeb Safari
Screen.Recording.2024-03-29.at.18.32.18.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-29.at.18.15.02.mov
MacOS: Desktop
Screen.Recording.2024-03-29.at.18.22.17.mov

@tienifr tienifr marked this pull request as ready for review April 1, 2024 04:46
@tienifr tienifr requested a review from a team as a code owner April 1, 2024 04:46
@melvin-bot melvin-bot bot requested review from alitoshmatov and removed request for a team April 1, 2024 04:46
Copy link

melvin-bot bot commented Apr 1, 2024

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

@tienifr
Copy link
Contributor Author

tienifr commented Apr 1, 2024

@danieldoglas In main branch, the text is "Test Preferences". In new design, we use "Testing Preferences". What should we use?

image

@danieldoglas
Copy link
Contributor

@tienifr please use the text from the new design

@tienifr
Copy link
Contributor Author

tienifr commented Apr 2, 2024

I just asked for the translations in slack. Once all the translations are added, you can review PR @alitoshmatov

@tienifr
Copy link
Contributor Author

tienifr commented Apr 3, 2024

@danieldoglas Can you help check this slack thread?

@tienifr tienifr requested a review from a team as a code owner April 3, 2024 07:32
@tienifr
Copy link
Contributor Author

tienifr commented Apr 3, 2024

@alitoshmatov I think you can review this PR while the internal team fulfills the translations

@shawnborton
Copy link
Contributor

The hovered row here should be going full width of the card:
CleanShot 2024-04-03 at 12 25 26@2x

@tienifr
Copy link
Contributor Author

tienifr commented Apr 3, 2024

@alitoshmatov All translations are added

@tienifr
Copy link
Contributor Author

tienifr commented Apr 4, 2024

@shawnborton I fixed comment
image

@alitoshmatov
Copy link
Contributor

alitoshmatov commented Apr 4, 2024

@tienifr subtitle styles are not matching. Also, I think the alignment is a bit off, I think it should match subtitles in other pages, for example about page.
Screenshot 2024-04-04 at 3 42 20 PM

@alitoshmatov
Copy link
Contributor

Also alignment of clear cache and restart menu item is off. Here also I think it should match styles in about page which also has similar menu items

PR:
Screenshot 2024-04-04 at 3 47 41 PM
Design:
Screenshot 2024-04-04 at 3 47 49 PM

@shawnborton
Copy link
Contributor

Hmm I think the Design might actually be off in this case, just slightly.

As long as this matches other rows in cards in Account Settings like these:
CleanShot 2024-04-04 at 14 27 40@2x

CleanShot 2024-04-04 at 14 28 00@2x

Then we're good to go.

@shawnborton
Copy link
Contributor

subtitle styles are not matching

Good catch on this, let's fix. Again, take a look at the other places in Settings like Security and About for inspiration on correct implementation.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 5, 2024

  • I fix two issues you mentioned:

subtitle styles are not matching

alignment of clear cache and restart menu item is off

  • Below is the result:
Design PR
image image

This comment has been minimized.

@dannymcclain
Copy link
Contributor

This is looking pretty good. I think the illustration in the header needs to be a bit bigger and centered:

CleanShot 2024-04-05 at 08 17 58@2x

And I ran into some weirdness with the nav on smaller viewports. Maybe that's unrelated to this, I'm not sure, so I thought I'd call it out:

  • Random nav item is "active" even though nothing should be active
  • Screens sometime animate in/out from the wrong side
CleanShot.2024-04-05.at.08.19.35.mp4

@tienifr
Copy link
Contributor Author

tienifr commented Apr 8, 2024

Not the lightbulb, but the animated lottie illustration in the card header area.

Oh sorry. I misunderstood @dannymcclain 's thought

Do we have any ability to increase the size of the inner lottie illustration or do we need to supply a new lottie file for that?

We can increase the size of the inner lottie by update these props, but I think it will be better if we supply a new lottie file

@shawnborton
Copy link
Contributor

Cool, I think we might be fine if we just do my suggestion above here - can you please try that and report back? Thanks!

@tienifr
Copy link
Contributor Author

tienifr commented Apr 9, 2024

@shawnborton I fixed the issue "the illustration in the header needs to be centered". Below is result:
Screenshot 2024-04-09 at 18 13 43
image

@tienifr
Copy link
Contributor Author

tienifr commented Apr 9, 2024

@shawnborton I just merged main, and there is a new option, named "Save the world". So what is the correct order when displaying these options? Currently this PR, is:
image

@shawnborton
Copy link
Contributor

Currently this PR, is:

That order looks good to me.

@shawnborton
Copy link
Contributor

I fixed the issue "the illustration in the header needs to be centered". Below is result:

This also looks good to me! I'd say we're ready for final review then. Thanks for the adjustments!

<Text style={[styles.textNormal, subtitleMuted && styles.colorMuted]}>{subtitle}</Text>
</View>
)}
{renderSubtitle
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What exactly does this do?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will style the text "Use the tools ... submit a bug"
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Did you test the submit a bug link? It doesn't work for me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I tested and It works well:

Screen.Recording.2024-04-09.at.18.50.59.mov

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, thanks for confirming.

Copy link
Contributor

github-actions bot commented Apr 9, 2024

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

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

👀 View the workflow run that generated this build 👀

@shawnborton
Copy link
Contributor

Looks like the header height is incorrect:
CleanShot 2024-04-09 at 13 48 17@2x

It should be 220px

@tienifr
Copy link
Contributor Author

tienifr commented Apr 9, 2024

@shawnborton I fixed this. Result:

image
image

@shawnborton
Copy link
Contributor

Thanks!

@shawnborton
Copy link
Contributor

@alitoshmatov can you please give this a review? Thanks!

@tienifr
Copy link
Contributor Author

tienifr commented Apr 12, 2024

@alitoshmatov Please help review PR once you have a chance

@alitoshmatov
Copy link
Contributor

Reviewing

@alitoshmatov
Copy link
Contributor

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
troubleshooting-android.mov
Android: mWeb Chrome
troubleshooting-mweb.mov
iOS: Native
troubleshooting-ios.mp4
iOS: mWeb Safari
troubleshooting-safari.mp4
MacOS: Chrome / Safari
troubleshooting-web.mov
MacOS: Desktop
troubleshooting-desktop.mov

Copy link
Contributor

@alitoshmatov alitoshmatov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes looks good

@melvin-bot melvin-bot bot requested a review from danieldoglas April 12, 2024 17:43
Copy link
Contributor

@danieldoglas danieldoglas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@danieldoglas danieldoglas merged commit 2815cf2 into Expensify:main Apr 15, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.63-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants