Show console debug logs via test tools menu #40656

ShridharGoel · 2024-04-21T12:38:46Z

Details

Show console debug logs via test tools menu.

Fixed Issues

$ #40208
PROPOSAL: #40208 (comment)

Tests

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

QA Steps

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

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-04-22.at.8.51.40.PM.mov

Android: mWeb Chrome

Screenrecording_20240422_215418.mp4

iOS: Native

Screen.Recording.2024-04-22.at.8.46.39.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-22.at.8.58.00.PM.mov

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-21T12:38:51Z

@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 · 2024-04-22T00:51:40Z

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

ShridharGoel · 2024-04-22T20:32:01Z

@dubielzyk-expensify Design review can be done now.

dubielzyk-expensify · 2024-04-23T02:32:03Z

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 · 2024-04-23T12:14:58Z

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 · 2024-04-23T19:43:57Z

@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 · 2024-04-23T19:44:23Z

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

shawnborton · 2024-04-23T19:45:10Z

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

dubielzyk-expensify

I'll approve from the design change as this seems good to us 😄 The footer button sounds like it'll be fixed in a separate issue

eVoloshchak · 2024-04-25T15:13:22Z

src/pages/settings/AboutPage/ShareLogList/BaseShareLogList.tsx

@@ -91,7 +91,13 @@ function BaseShareLogList({onAttachLogToReport}: BaseShareLogListProps) {
                <>
                    <HeaderWithBackButton
                        title={translate('initialSettingsPage.debugConsole.shareLog')}
-                        onBackButtonPress={() => Navigation.goBack(ROUTES.SETTINGS_CONSOLE)}
+                        onBackButtonPress={() => {


This logic doesn't work correctly in some cases

24-04-25-17-10-20.mp4

But I was wondering if we need the isViaTestToolsModal prop at all. Is its only purpose is to conditionally navigate to a different page onBackButtonPress?

@ShridharGoel, friendly bump on this comment

Yes, it is used to navigate based on the source via which the debug console was opened.

eVoloshchak · 2024-04-25T15:19:17Z

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

24-04-25-17-10-45.mp4

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?

24-04-25-17-18-07.mp4

dubielzyk-expensify · 2024-04-26T02:40:33Z

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 · 2024-04-28T18:13:14Z

@ShridharGoel, could you implement the changes described in #40656 (comment)?

ShridharGoel · 2024-04-28T20:40:41Z

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

ShridharGoel · 2024-05-08T13:59:21Z

src/components/TestToolsModal.tsx

+                            text={translate('initialSettingsPage.debugConsole.viewConsole')}
+                            onPress={() => {
+                                toggleTestToolsModal();
+                                Navigation.navigate(ROUTES.SETTINGS_CONSOLE.getRoute(Navigation.getActiveRoute()));


But it will not always be ROUTES.HOME I think. What if this is opened via some chat?

That is true. I assumed you can't open the debug menu web (can you?), but even if you can't, let's keep Navigation.getActiveRoute() since it's more universal. Thanks!

It can't be opened on web, but on mobile it can be opened via any page.

eVoloshchak · 2024-05-08T13:44:31Z

src/pages/settings/AboutPage/ConsolePage.tsx

@@ -44,6 +48,8 @@ function ConsolePage({capturedLogs, shouldStoreLogs}: ConsolePageProps) {
    const {translate} = useLocalize();
    const styles = useThemeStyles();



Suggested change

eVoloshchak · 2024-05-08T13:47:39Z

Bug:

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

Screen.Recording.2024-05-08.at.15.27.28.mov

ShridharGoel · 2024-05-08T14:08:18Z

@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 · 2024-05-08T16:05:31Z

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

24-05-08-18-04-13.mp4

Android: mWeb Chrome

Screen.Recording.2024-05-08.at.18.02.29.mov

iOS: Native

Screen.Recording.2024-05-08.at.18.03.19.mov

iOS: mWeb Safari

Screen.Recording.2024-05-08.at.18.08.58.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-08.at.17.59.20.mov

MacOS: Desktop

Screen.Recording.2024-05-08.at.18.01.04.mov

eVoloshchak

LGTM!

Beamanator · 2024-05-09T07:16:38Z

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 · 2024-05-16T09:21:01Z

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?

Beamanator

Looks good to me, @eVoloshchak can you please review today? 🙏

eVoloshchak

Tests well!

Beamanator · 2024-05-21T07:51:29Z

Thanks y'all! Seems we're still on the merge freeze

ShridharGoel · 2024-05-29T11:18:29Z

@Beamanator Can we merge this?

Beamanator · 2024-05-29T12:32:52Z

Oof thanks for the ping, let's merge main again and test, since the last commit was over a week ago

Beamanator · 2024-05-29T12:54:33Z

Thanks! @eVoloshchak can you please test again to make sure we're good to merge? 🙏

eVoloshchak

Looks good and tests well

Beamanator

LGTM!

OSBotify · 2024-05-30T07:17:25Z

✋ 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-05-30T21:53:29Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:29:59Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.77-11 🚀

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

OSBotify · 2024-06-04T13:56:01Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.78-5 🚀

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

Show console debug logs via test tools menu

46a6c3e

ShridharGoel requested review from a team as code owners April 21, 2024 12:38

melvin-bot bot requested review from eVoloshchak and removed request for a team April 21, 2024 12:38

ShridharGoel marked this pull request as draft April 21, 2024 12:39

Update

a323a21

ShridharGoel force-pushed the view-logs branch from 439a9ab to a323a21 Compare April 21, 2024 19:49

ShridharGoel added 3 commits April 22, 2024 01:19

Fix number of taps

d9ec214

Fix test tools modal visibility condition

64873dd

Typecheck fixes

65e4338

Update

8af99fe

ShridharGoel marked this pull request as ready for review April 22, 2024 20:26

ShridharGoel mentioned this pull request Apr 22, 2024

[HOLD for payment 2024-06-11] MEDIUM: [$500] Add button to console log to four finger tap menu #40208

Closed

dubielzyk-expensify previously approved these changes Apr 24, 2024

View reviewed changes

eVoloshchak suggested changes Apr 25, 2024

View reviewed changes

ShridharGoel dismissed dubielzyk-expensify’s stale review via 17a3342 April 29, 2024 11:21

ShridharGoel force-pushed the view-logs branch from 55af4af to 17a3342 Compare April 29, 2024 11:21

ShridharGoel requested a review from eVoloshchak May 8, 2024 12:26

Fixes

c64c55f

eVoloshchak suggested changes May 8, 2024

View reviewed changes

eVoloshchak approved these changes May 8, 2024

View reviewed changes

melvin-bot bot requested a review from Beamanator May 8, 2024 16:10

Beamanator changed the title ~~Show console debug logs via test tools menu~~ [HOLD merge freeze] Show console debug logs via test tools menu May 9, 2024

Beamanator changed the title ~~[HOLD merge freeze] Show console debug logs via test tools menu~~ Show console debug logs via test tools menu May 16, 2024

Merge branch 'main' of https://github.com/Expensify/App into view-logs

ae229bd

ShridharGoel requested a review from eVoloshchak May 16, 2024 19:00

Beamanator approved these changes May 17, 2024

View reviewed changes

eVoloshchak approved these changes May 17, 2024

View reviewed changes

melvin-bot bot requested a review from Beamanator May 17, 2024 17:15

Merge branch 'main' of https://github.com/Expensify/App into view-logs

f7d5ead

eVoloshchak approved these changes May 29, 2024

View reviewed changes

Beamanator approved these changes May 30, 2024

View reviewed changes

Beamanator merged commit ef6e012 into Expensify:main May 30, 2024
16 checks passed

github-actions bot mentioned this pull request May 30, 2024

Deploy Checklist: New Expensify 2024-05-30 #42872

Closed

95 tasks

		@@ -44,6 +48,8 @@ function ConsolePage({capturedLogs, shouldStoreLogs}: ConsolePageProps) {
		const {translate} = useLocalize();
		const styles = useThemeStyles();

Show console debug logs via test tools menu #40656

Show console debug logs via test tools menu #40656

Conversation

ShridharGoel commented Apr 21, 2024 • edited Loading

Details

Fixed Issues

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 21, 2024

dubielzyk-expensify commented Apr 22, 2024

ShridharGoel commented Apr 22, 2024

dubielzyk-expensify commented Apr 23, 2024

shawnborton commented Apr 23, 2024

ShridharGoel commented Apr 23, 2024

ShridharGoel commented Apr 23, 2024

shawnborton commented Apr 23, 2024

dubielzyk-expensify left a comment

Choose a reason for hiding this comment

eVoloshchak Apr 25, 2024

Choose a reason for hiding this comment

eVoloshchak May 2, 2024

Choose a reason for hiding this comment

ShridharGoel May 2, 2024

Choose a reason for hiding this comment

eVoloshchak commented Apr 25, 2024

dubielzyk-expensify commented Apr 26, 2024

eVoloshchak commented Apr 28, 2024

ShridharGoel commented Apr 28, 2024

This comment was marked as resolved.

ShridharGoel May 8, 2024

Choose a reason for hiding this comment

eVoloshchak May 8, 2024

Choose a reason for hiding this comment

ShridharGoel May 8, 2024

Choose a reason for hiding this comment

eVoloshchak May 8, 2024

Choose a reason for hiding this comment

eVoloshchak commented May 8, 2024

ShridharGoel commented May 8, 2024

eVoloshchak commented May 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

Beamanator commented May 9, 2024

Beamanator commented May 16, 2024

Beamanator left a comment

Choose a reason for hiding this comment

eVoloshchak left a comment

Choose a reason for hiding this comment

Beamanator commented May 21, 2024

ShridharGoel commented May 29, 2024

Beamanator commented May 29, 2024

Beamanator commented May 29, 2024

eVoloshchak left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

OSBotify commented Jun 4, 2024

ShridharGoel commented Apr 21, 2024 •

edited

Loading

eVoloshchak commented May 8, 2024 •

edited

Loading