Show console debug logs via test tools menu

[ShridharGoel]

Details

Show console debug logs via test tools menu.

Fixed Issues

$ https://github.com/Expensify/App/issues/40208 PROPOSAL: https://github.com/Expensify/App/issues/40208#issuecomment-2053741494

Tests

1. Open test tools menu by four-finger tap or via "Open Test Preferences" option.
2. Switch on client side logging.
3. A new option should show to view the debug console.
4. Click on the option.
5. Debug console should show.
6. Test the save logs option.
7. Test the share logs option.

QA Steps

1. Open test tools menu by four-finger tap or via "Open Test Preferences" option.
2. Switch on client side logging.
3. A new option should show to view the debug console.
4. Click on the option.
5. Debug console should show.
6. Test the save logs option.
7. Test the share logs option.

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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

https://github.com/Expensify/App/assets/35566748/ad587266-097c-424e-be08-28da799e045d

Android: mWeb Chrome

https://github.com/Expensify/App/assets/35566748/67b03442-8ac6-4fe3-8e7e-220775bc21f1

iOS: Native

https://github.com/Expensify/App/assets/35566748/f86d2138-d1c3-4c88-9a57-f76fa201bd94

iOS: mWeb Safari

https://github.com/Expensify/App/assets/35566748/4fdc54e0-99cc-4206-95c7-fef9273f3285

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot[bot]]

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

[dubielzyk-expensify]

Let us know when you're ready for design review 😄

[ShridharGoel]

@dubielzyk-expensify Design review can be done now.

[dubielzyk-expensify]

Doesn't look like there's anything new other than a shortcut from Test Prefs so this looks good to me. Can you confirm that's the case? We haven't tweaked the debug console screen at all?

cc @Expensify/design for visibility

[shawnborton]

Only minor comment from me is that it feels like the button is too close to the bottom?

We had a regression related to that recently, so you might just need to pull main to fix that?

[ShridharGoel]

@shawnborton It's the same on staging, and unrelated to these changes since we haven't changed the UI here. I think we can create an issue to fix it?

[ShridharGoel]

I also checked after pulling main, it's still the same.

[shawnborton]

Okay, cc @luacmartins - another spot where the footer button is broken

[eVoloshchak]

@dubielzyk-expensify, this modal doesn't look right to me, it ends up being "inside" of the test tools menu

https://github.com/Expensify/App/assets/9059945/91df0a10-aafe-47c6-8185-2fe09a1ba327

Could you please confirm what is the expected result here? A new modal that is the exact size of the test tools menu modal? A full-screen modal? Or just navigate to a "Debug console" page like it happens currently?

https://github.com/Expensify/App/assets/9059945/b5732a60-138b-429d-884b-596e2c840853

[dubielzyk-expensify]

Could you please confirm what is the expected result here? A new modal that is the exact size of the test tools menu modal? A full-screen modal? Or just navigate to a "Debug console" page like it happens currently?

Good point. Yeah I think just navigating to the Debug Console is the right move here cause you're right that it feels weird to show the console within a modal

[eVoloshchak]

@ShridharGoel, could you implement the changes described in https://github.com/Expensify/App/pull/40656#issuecomment-2078535642?

[ShridharGoel]

@eVoloshchak Yes, I'm working on the changes.

[ShridharGoel]

@eVoloshchak Updated.

[ShridharGoel]

@eVoloshchak Can you check this when possible?

[eVoloshchak]

@ShridharGoel, are you able to test this on iOS? For me the app crashes when you open a debug menu

https://github.com/Expensify/App/assets/9059945/3d9b7b8b-b05a-47d8-af76-3fd55eb35328

[ShridharGoel]

@eVoloshchak Yeah, you can use Command+D to get the test menu option.

[ShridharGoel]

@eVoloshchak Were you able to check it?

[Beamanator]

@ShridharGoel looks like you've got some conflicts, can you please fix? And @eVoloshchak @ShridharGoel did y'all get the iOS crash resolved?

[Beamanator]

@eVoloshchak can you confirm if the crash you noted still exists, or if you agree this has something to do with the "Shake" option in the simulator? (see this comment)

@ShridharGoel when can you get to the latest review comments & fixing the conflicts here?

[eVoloshchak]

can you confirm if the crash you noted still exists

@Beamanator, the crash issue still exists, verified it is also present om main, so unrelated to this PR

[ShridharGoel]

@Beamanator Some changes are done, need discussion on this: https://github.com/Expensify/App/pull/40656#discussion_r1591470739

[ShridharGoel]

@eVoloshchak Can you have a look?

[eVoloshchak]

Bug:

1. Open test tools menu by four-finger tap
2. Switch on client-side logging.
3. Press the View console button
4. Press back
5. Notice the animation is wrong (home screen slides in from the right on top of the current screen) 00:08
6. Press on "Account Settings"
7. Notice the animation is wrong (home screen slides to the right to reveal settings page) 00:14
8. Toggle between "Chats" and"Account Settings"
9. Notice the animation is back to default
10. Press on "Account Settings"
11. Animation is back to default, 00:14

https://github.com/Expensify/App/assets/9059945/0b2c1d7b-410a-44ec-8132-c09a6525ed51

[ShridharGoel]

@eVoloshchak This seems to be production behaviour, can you check by using the troubleshoot page and going to debug console and coming back? The page slides from right to left.

[eVoloshchak]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/9059945/6294419f-7c95-4eca-81ff-fb1ae333006e

Android: mWeb Chrome

https://github.com/Expensify/App/assets/9059945/7189fe54-933a-480e-9330-6e0d72041613

iOS: Native

https://github.com/Expensify/App/assets/9059945/642728c2-7f51-4067-ad73-8221eb73bf3f

iOS: mWeb Safari

https://github.com/Expensify/App/assets/9059945/fd9ef791-7bb9-4fb3-b596-5727d3d1dde6

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/9059945/39e08f58-7023-4116-97ee-73519d6c68c6

MacOS: Desktop

https://github.com/Expensify/App/assets/9059945/5be10a2f-bfec-4d91-991c-197564b282eb

[Beamanator]

Thanks so much for the hard work, both of you! I'm putting this on HOLD because we're in a merge freeze till Monday I believe - see https://expensify.slack.com/archives/C01GTK53T8Q/p1715105636003919

[Beamanator]

Alright gents, this PR is off hold!

@ShridharGoel can you please pull main & retest? And @eVoloshchak can you please also retest once main is pulled in?