Add Troubleshoot menu to PublicScreens #56926

OlimpiaZurek · 2025-02-17T10:15:13Z

Explanation of Change

This PR adds the Troubleshoot menu to the sign in page to be accessible in browsers (CMD+D) and Standalone App (four-finger tap).

Some options are unnecessary on the Sign In page, so they've been disabled.

Additionally, to ensure the Debug Console modal works properly, it also had to be accessible from the PublicScreen. I extracted it from the Settings screen to keep it public while hiding other options with the isAuthenticated flag.

Fixed Issues

$ #56925
PROPOSAL:

Tests

Open the App (Login Page)
Press CMD + D (Browser) or perform a four-finger tap (Mobile)
Verify that the Troubleshoot menu appears.
Check that all options in the menu are functional and correctly displayed

Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests

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

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen_Recording_20250217-141443_New.Expensify.Dev.mp4

Android: mWeb Chrome

N/A

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.-.2025-02-17.at.14.18.00.mp4

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

Screen.Recording.2025-02-17.at.14.17.36.mov

MacOS: Desktop

melvin-bot · 2025-02-17T13:49:54Z

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

jjcoffee · 2025-02-17T16:02:14Z

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

android-app-2025-02-17_17.43.05.mp4

Android: mWeb Chrome

N/A

iOS: Native

ios-app-2025-02-17_17.49.38.mp4

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

desktop-chrome-2025-02-17_17.10.11.mp4

MacOS: Desktop

desktop-app-2025-02-17_17.20.51.mp4

jjcoffee · 2025-02-17T16:03:07Z

@OlimpiaZurek Looking good so far! Just a quick question, how were you able to simulate the four-finger tap on iOS?

OlimpiaZurek · 2025-02-18T09:11:58Z

@OlimpiaZurek Looking good so far! Just a quick question, how were you able to simulate the four-finger tap on iOS?

I wasn’t able to simulate the four-finger tap, it works after pressing Cmd+D, just like in browsers.

OlimpiaZurek · 2025-02-18T09:12:27Z

BUG?: Using the Authentication status: Invalidate option results in the app opening with an endless skeleton loader. Maybe we should hide some more options that don't make sense to be used before logging in? I think Device credentials is another contender for removal.

desktop-chrome-issue-2025-02-17_17.07.54.mp4

I couldn’t reproduce it on my end, but it’s possible that some options should be disabled before logging in. I’ll take a look and see which ones don’t make sense to have active here.

fabioh8010 · 2025-02-24T09:34:56Z

src/components/TestToolMenu.tsx

                    />
                </TestToolRow>
            )}
-
-            {/* When toggled the app will be forced offline. */}


Why was this removed?

Removed by accident, reverted

fabioh8010 · 2025-02-24T09:35:26Z

src/components/TestToolMenu.tsx

-            {/* Option to switch between staging and default api endpoints.
-        This enables QA, internal testers and external devs to take advantage of sandbox environments for 3rd party services like Plaid and Onfido.
-        This toggle is not rendered for internal devs as they make environment changes directly to the .env file. */}


fabioh8010 · 2025-02-24T09:35:32Z

src/components/TestToolMenu.tsx

                    disabled={!!isUsingImportedState || !!network?.shouldSimulatePoorConnection || network?.shouldFailAllRequests}
                />
            </TestToolRow>
-
-            {/* When toggled the app will randomly change internet connection every 2-5 seconds */}


fabioh8010 · 2025-02-24T09:35:37Z

src/components/TestToolMenu.tsx

                    disabled={!!isUsingImportedState || !!network?.shouldFailAllRequests || network?.shouldForceOffline}
                />
            </TestToolRow>
-
-            {/* When toggled all network requests will fail. */}


fabioh8010 · 2025-02-24T09:36:10Z

src/components/TestToolsModal.tsx

@@ -25,7 +25,6 @@ function TestToolsModal() {
    const StyleUtils = useStyleUtils();
    const styles = useThemeStyles();
    const {translate} = useLocalize();
-


Could you revert this?

fabioh8010 · 2025-02-24T10:45:05Z

src/libs/Navigation/types.ts

@@ -74,6 +74,9 @@ type BackToAndForwardToParms = {
    forwardTo?: Routes;
 };

+type ConsoleNavigatorParamList = {
+    [SCREENS.CONSOLE_DEBUG]: undefined;
+};


Suggested change

};

};

fabioh8010 · 2025-02-24T10:46:03Z

src/pages/settings/AboutPage/ConsolePage.tsx

-    const route = useRoute<PlatformStackRouteProp<SettingsNavigatorParamList, typeof SCREENS.SETTINGS.CONSOLE>>();
+    const route = useRoute<PlatformStackRouteProp<SettingsNavigatorParamList, typeof SCREENS.CONSOLE_DEBUG>>();
+    const [session] = useOnyx(ONYXKEYS.SESSION);
+    const isAuthenticated = useMemo(() => !!(session?.authToken ?? null), [session]);


Maybe we should create a useIsAuthenticated hook for this? I'm seeing this exact piece of code in several files now.

OlimpiaZurek · 2025-02-24T15:01:33Z

@jjcoffee I've made few changes. Can you take a look and review again? Thanks!

fabioh8010

Minor comment, LGTM

fabioh8010 · 2025-02-24T15:44:59Z

src/components/TestToolMenu.tsx

+            This enables QA, internal testers and external devs to take advantage of sandbox environments for 3rd party services like Plaid and Onfido.
+             This toggle is not rendered for internal devs as they make environment changes directly to the .env file. */}


Could you revert the spaces?

jjcoffee · 2025-02-24T15:52:48Z

NAB: The order of the options is different from staging. We don't need to block on this, but if it's an easy fix, I think it might annoy some people that the options have jumped around 😄

Staging:

Current PR:

jjcoffee

LGTM! I'll leave it up to the assigned engineer on whether this needs to be sorted.

melvin-bot · 2025-02-24T15:58:25Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #56925 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

jjcoffee

Approving again to get the auto-assigned engineer!

OSBotify · 2025-02-24T16:23:38Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OlimpiaZurek · 2025-02-24T17:12:07Z

NAB: The order of the options is different from staging. We don't need to block on this, but if it's an easy fix, I think it might annoy some people that the options have jumped around 😄

The order has changed due to simplified logic, as some options are now hidden behind the isAuthenticated flag. I don’t think this will be an issue once these changes are deployed.

github-actions · 2025-02-24T20:14:59Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.1.5-0 🚀

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

IuliiaHerets · 2025-02-24T22:00:27Z

This PR is failing for iOS and Android because of issue #57350

jjcoffee · 2025-02-25T08:40:44Z

@IuliiaHerets I can repro the same issue before this PR's changes.

IuliiaHerets · 2025-02-25T12:49:15Z

@jjcoffee Yep, issue is repro on prod too. But PR asks to check if a menu is correctly displayed. In this case, PR is fail

…oubleshoot-menu-to-publicscreens" This reverts commit fd654cb, reversing changes made to aea1f85.

Revert "Merge pull request #56926 from callstack-internal/feat/add-tr…

Revert "Merge pull request #56926 from callstack-internal/feat/add-tr… (cherry picked from commit b08d157) (CP triggered by chiragsalian)

github-actions · 2025-02-26T00:04:06Z

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

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

github-actions · 2025-02-26T00:23:04Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.1.6-0 🚀

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

github-actions · 2025-02-26T10:43:24Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.1.6-0 🚀

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

github-actions · 2025-02-26T22:40:43Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.1.6-1 🚀

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

OlimpiaZurek force-pushed the feat/add-troubleshoot-menu-to-publicscreens branch 2 times, most recently from 0c8832c to 581179a Compare February 17, 2025 13:23

OlimpiaZurek marked this pull request as ready for review February 17, 2025 13:49

OlimpiaZurek requested a review from a team as a code owner February 17, 2025 13:49

melvin-bot bot requested review from jjcoffee and removed request for a team February 17, 2025 13:49

This comment was marked as resolved.

Sign in to view

OlimpiaZurek force-pushed the feat/add-troubleshoot-menu-to-publicscreens branch 2 times, most recently from aa55641 to a79f87b Compare February 24, 2025 09:46

fabioh8010 reviewed Feb 24, 2025

View reviewed changes

OlimpiaZurek force-pushed the feat/add-troubleshoot-menu-to-publicscreens branch from 8ebb782 to a528005 Compare February 24, 2025 12:25

OlimpiaZurek added 5 commits February 24, 2025 14:12

Add Troubleshoot menu to PublicScreens

75a6657

disable viewConsole for unauthenticated users

9ee1e60

disable unnecessary options

ce5ff6c

fix lint

f6cd832

cr tweaks

4dfeace

OlimpiaZurek force-pushed the feat/add-troubleshoot-menu-to-publicscreens branch from a528005 to 4dfeace Compare February 24, 2025 13:44

OlimpiaZurek requested a review from fabioh8010 February 24, 2025 14:59

fabioh8010 approved these changes Feb 24, 2025

View reviewed changes

minor change

001eb5d

jjcoffee approved these changes Feb 24, 2025

View reviewed changes

melvin-bot bot requested a review from carlosmiceli February 24, 2025 15:59

carlosmiceli approved these changes Feb 24, 2025

View reviewed changes

carlosmiceli merged commit fd654cb into Expensify:main Feb 24, 2025
18 checks passed

github-actions bot mentioned this pull request Feb 24, 2025

Deploy Checklist: New Expensify 2025-02-24 #57336

Closed

52 tasks

IuliiaHerets mentioned this pull request Feb 24, 2025

[$250] iOS&Android - Troubleshoot menu cut in top and bottom after enabling and disabling "Use profiling" #57350

Open

8 tasks

carlosmiceli added a commit that referenced this pull request Feb 25, 2025

Revert "Merge pull request #56926 from callstack-internal/feat/add-tr…

d49a6d4

…oubleshoot-menu-to-publicscreens" This reverts commit fd654cb, reversing changes made to aea1f85.

chiragsalian added a commit that referenced this pull request Feb 25, 2025

Merge pull request #57421 from Expensify/cm-revert-56926

b08d157

Revert "Merge pull request #56926 from callstack-internal/feat/add-tr…

OSBotify pushed a commit that referenced this pull request Feb 25, 2025

Merge pull request #57421 from Expensify/cm-revert-56926

d7e684d

Revert "Merge pull request #56926 from callstack-internal/feat/add-tr… (cherry picked from commit b08d157) (CP triggered by chiragsalian)

github-actions bot mentioned this pull request Feb 25, 2025

Deploy Checklist: New Expensify 2025-02-25 #57435

Closed

49 tasks

melvin-bot bot mentioned this pull request Feb 26, 2025

[Due for payment 2025-03-05] [Due for payment 2025-03-05] Make Troubleshoot menu available in Sign In page #56925

Open

mallenexpensify mentioned this pull request Feb 27, 2025

[HOLD PR #56819][CRITICAL][Skeleton] App is not loading and appears only loading skeleton for ever #57356

Open

8 tasks

		This enables QA, internal testers and external devs to take advantage of sandbox environments for 3rd party services like Plaid and Onfido.
		This toggle is not rendered for internal devs as they make environment changes directly to the .env file. */}

Add Troubleshoot menu to PublicScreens #56926

Add Troubleshoot menu to PublicScreens #56926

Conversation

OlimpiaZurek commented Feb 17, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 17, 2025

jjcoffee commented Feb 17, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Feb 17, 2025

This comment was marked as resolved.

OlimpiaZurek commented Feb 18, 2025

OlimpiaZurek commented Feb 18, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OlimpiaZurek commented Feb 24, 2025

fabioh8010 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjcoffee commented Feb 24, 2025

jjcoffee left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Feb 24, 2025

jjcoffee left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 24, 2025

OlimpiaZurek commented Feb 24, 2025

github-actions bot commented Feb 24, 2025

IuliiaHerets commented Feb 24, 2025

jjcoffee commented Feb 25, 2025

IuliiaHerets commented Feb 25, 2025

github-actions bot commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

OlimpiaZurek commented Feb 17, 2025 •

edited

Loading

jjcoffee commented Feb 17, 2025 •

edited

Loading