Save logs data in downloads and show meaningful path #40777

ShridharGoel · 2024-04-23T11:45:39Z

Details

Save logs data in downloads and show meaningful path.

Fixed Issues

$ #40213
PROPOSAL: #40213 (comment)

Tests

Open test tools menu by four-finger tap or via "Open Test Preferences" option.
Switch on client side logging.
Switch off client side logging.
Check the file path.
Ensure that file is actually saved in that displayed path.
Do the same for profiling.

QA Steps

Open test tools menu by four-finger tap or via "Open Test Preferences" option.
Switch on client side logging.
Switch off client side logging.
Check the file path.
Ensure that file is actually saved in that displayed path.
Do the same for profiling.

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-23T11:45:44Z

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

ishpaul777 · 2024-04-25T17:38:37Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

ishpaul777 · 2024-04-25T17:47:12Z

src/components/ClientSideLoggingToolMenu/BaseClientSideLoggingToolMenu.tsx

@@ -70,7 +72,7 @@ function BaseClientSideLoggingToolMenu({shouldStoreLogs, capturedLogs, file, onS
            </TestToolRow>
            {!!file && (
                <>
-                    <Text style={[styles.textLabelSupporting, styles.mb4]}>{`path: ${file.path}`}</Text>
+                    <Text style={[styles.textLabelSupporting, styles.mb4]}>{`path: ${displayPath}/${file.newFileName}`}</Text>


I think we dont need file and displaypath both here, pass the display path (${displayPath}/${file.newFileName}`) only and build it in parent component

ishpaul777 · 2024-04-25T17:47:44Z

src/components/ClientSideLoggingToolMenu/index.android.tsx

@@ -38,6 +38,7 @@ function ClientSideLoggingToolMenu() {
            onEnableLogging={() => setFile(undefined)}
            onDisableLogging={createAndSaveFile}
            onShareLogs={shareLogs}
+            displayPath="/Downloads"


use constant for /Downloads

ishpaul777 · 2024-04-25T17:47:57Z

src/components/ClientSideLoggingToolMenu/index.ios.tsx

@@ -28,6 +28,7 @@ function ClientSideLoggingToolMenu() {
            onEnableLogging={() => setFile(undefined)}
            onDisableLogging={createFile}
            onShareLogs={shareLogs}
+            displayPath="/New Expensify"


use constant

ishpaul777 · 2024-04-25T17:53:58Z

src/components/ProfilingToolMenu/BaseProfilingToolMenu.tsx

@@ -83,15 +88,16 @@ function ProfilingToolMenu({isProfilingInProgress = false}: ProfilingToolMenuPro
        [totalMemory, usedMemory],
    );

+    const newFileName = `Profile_trace_for_${pkg.version}.cpuprofile`;


i think this can be moved outside the component

…nloads

ishpaul777 · 2024-04-29T05:49:44Z

src/components/ProfilingToolMenu/index.ios.tsx

+    return (
+        <BaseProfilingToolMenu
+            pathToBeUsed={RNFS.DocumentDirectoryPath}
+            displayPath="/New Expensify"


use costant whereever we use /Downloads and /New Expensify

ishpaul777 · 2024-04-29T06:27:55Z

src/CONST.ts

@@ -4713,6 +4713,9 @@ const CONST = {

    MAX_TAX_RATE_INTEGER_PLACES: 4,
    MAX_TAX_RATE_DECIMAL_PLACES: 4,
+
+    DOWNLOADS_PATH: '/Downloads',
+    NEW_EXPENSIFY_PATH: '/New Expensify',


this path will be different for all type build dev/staging/prod we have useEnvironment to know which environment we are in

ishpaul777 · 2024-04-29T20:11:53Z

@ShridharGoel Whats you ETA for resolving above comments

ShridharGoel · 2024-04-29T20:42:42Z

It is done locally, will be testing once again tomorrow and then will update.

ShridharGoel · 2024-04-30T09:05:48Z

@ishpaul777 Updated.

ishpaul777 · 2024-04-30T20:14:32Z

@ShridharGoel Can you please resolve conflicts, @techievivek Can you please help running a adhoc build once conflicts resolved 🙏

ishpaul777 · 2024-04-30T20:24:20Z

src/libs/getFolderPathSuffix.ts

+            folderSuffix = '';
+            break;
+        case CONST.ENVIRONMENT.ADHOC:
+            folderSuffix = ' AdHoc';


use constants we have in CONST.ENVIRONMENT

The existing ones don't have the same values which we need. Should we go ahead with new constants?

src/libs/getFolderPathSuffix.ts

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

…nsifyApp into save-downloads

ishpaul777 · 2024-05-02T20:21:47Z

package-lock.json

Not sure how this change got added, will revert

@ShridharGoel Let's revert this one so we can move forward with the merge.

@techievivek Updated.

ishpaul777

Looks good! we just need to uncommit unnecessary package-lock.json file changes. Approving because i'll be OOO until monday

techievivek

Looks good, thanks.

OSBotify · 2024-05-03T09:55:43Z

✋ 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-09T02:10:22Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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

Save logs data in downloads and show meaningful path

8a27a7d

ShridharGoel requested a review from a team as a code owner April 23, 2024 11:45

melvin-bot bot requested review from ishpaul777 and removed request for a team April 23, 2024 11:45

Type fixes

82788e4

ShridharGoel mentioned this pull request Apr 23, 2024

[HOLD for payment 2024-05-16] ][HIGH] [Debugability] [$500] Save client-side logs and profile traces to the Downloads folder #40213

Closed

ishpaul777 suggested changes Apr 25, 2024

View reviewed changes

ShridharGoel added 4 commits April 28, 2024 19:59

Merge branch 'main' of https://github.com/Expensify/App into save-dow…

fd8e965

…nloads

Update

d1bdd49

Update

86b9836

Merge branch 'main' of https://github.com/Expensify/App into save-dow…

afe7814

…nloads

ishpaul777 reviewed Apr 29, 2024

View reviewed changes

ShridharGoel added 5 commits April 30, 2024 13:05

Update

c7c14f4

Update

dac895c

Change Adhoc to AdHoc

3c6c01d

Update

b5e54f9

Fix typecheck

1a6ac07

ishpaul777 reviewed Apr 30, 2024

View reviewed changes

src/libs/getFolderPathSuffix.ts Outdated Show resolved Hide resolved

ShridharGoel and others added 2 commits May 2, 2024 15:41

Update src/libs/getFolderPathSuffix.ts

f3b9bf4

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

Merge branch 'main' into save-downloads

a9d5766

techievivek assigned ShridharGoel May 2, 2024

techievivek added the Ready To Build label May 2, 2024

ShridharGoel added 5 commits May 2, 2024 19:27

Rename getFolderPathSuffix.ts to getDownloadFolderPathSuffixForIOS.ts

14fddd0

Merge branch 'save-downloads' of https://github.com/ShridharGoel/Expe…

5fc78ad

…nsifyApp into save-downloads

Update

27d45bb

Update

ace5f4e

Update constants

a04a574

ishpaul777 reviewed May 2, 2024

View reviewed changes

ishpaul777 approved these changes May 2, 2024

View reviewed changes

melvin-bot bot requested a review from techievivek May 2, 2024 20:27

Update package-lock.json

2cbb037

techievivek approved these changes May 3, 2024

View reviewed changes

techievivek merged commit 0f39e43 into Expensify:main May 3, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-05-07 #41716

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Save logs data in downloads and show meaningful path #40777

Save logs data in downloads and show meaningful path #40777

ShridharGoel commented Apr 23, 2024

melvin-bot bot commented Apr 23, 2024

ishpaul777 commented Apr 25, 2024 •

edited

Loading

ishpaul777 Apr 25, 2024 •

edited

Loading

ishpaul777 Apr 25, 2024

ishpaul777 Apr 25, 2024

ishpaul777 Apr 25, 2024

ishpaul777 Apr 29, 2024

ishpaul777 Apr 29, 2024

ishpaul777 commented Apr 29, 2024

ShridharGoel commented Apr 29, 2024

ShridharGoel commented Apr 30, 2024

ishpaul777 commented Apr 30, 2024 •

edited

Loading

ishpaul777 Apr 30, 2024

ShridharGoel May 2, 2024

ishpaul777 May 2, 2024

ShridharGoel May 2, 2024

techievivek May 3, 2024

ShridharGoel May 3, 2024

ishpaul777 left a comment

techievivek left a comment

OSBotify commented May 3, 2024

OSBotify commented May 9, 2024

Save logs data in downloads and show meaningful path #40777

Save logs data in downloads and show meaningful path #40777

Conversation

ShridharGoel commented Apr 23, 2024

Details

Fixed Issues

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 23, 2024

ishpaul777 commented Apr 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 Apr 25, 2024 • edited Loading

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

ishpaul777 commented Apr 29, 2024

ShridharGoel commented Apr 29, 2024

ShridharGoel commented Apr 30, 2024

ishpaul777 commented Apr 30, 2024 • edited Loading

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

ishpaul777 left a comment

Choose a reason for hiding this comment

techievivek left a comment

Choose a reason for hiding this comment

OSBotify commented May 3, 2024

OSBotify commented May 9, 2024

ishpaul777 commented Apr 25, 2024 •

edited

Loading

ishpaul777 Apr 25, 2024 •

edited

Loading

ishpaul777 commented Apr 30, 2024 •

edited

Loading