feat: log network response and request with filter options in debug console by hurali97 · Pull Request #45769 · Expensify/App

hurali97 · 2024-07-19T12:49:02Z

Details

Fixed Issues

$ #45275
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Run the app on environment other than Dev
Enable Client side logging
Close the App and re launch it
Click on View debug console in Settings-> Trouble Shoot
Click on the three dot menu
Filter the logs to Network
You should only see logs with Network keyword
Download the network only logs
Change the extension to .json and open in any editor
Verify that the output is readable and contains request and response data for API related logs

You can also follow the video:

Video

logs.mp4

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…ug Console

…y-App into hur/feat/log-network-response

muttmuure · 2024-07-24T10:09:19Z

Tagging this held issue here so we can unblock it later: #45275

hurali97 · 2024-07-25T12:25:22Z

Linting and TS checks are failing because of missing type for extraData argument in Log.info function and clientLoggingCallback. This is fixed in expensify-common repo here

…nd desktop

…y-App into hur/feat/log-network-response

melvin-bot · 2024-07-26T12:48:39Z

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

allroundexperts · 2024-07-28T21:37:10Z

@hurali97 Lint and Type checks failing.

allroundexperts · 2024-07-28T21:37:27Z

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

Screen.Recording.2024-07-31.at.2.24.15.PM.mov

MacOS: Desktop

hurali97 · 2024-07-29T07:01:49Z

@hurali97 Lint and Type checks failing.

@allroundexperts Reasons here

…y-App into hur/feat/log-network-response

allroundexperts · 2024-07-31T08:54:44Z

@hurali97 Conflicts.

allroundexperts · 2024-07-31T09:16:47Z

package.json

    "dom-serializer": "^0.2.2",
    "domhandler": "^4.3.0",
-    "expensify-common": "2.0.57",
+    "expensify-common": "2.0.60",


This needs to be updated as new version is available now!

@allroundexperts I have no issues bumping it in this PR but this version bumped here is specifically related to the changes in the PR. If I bump it here and there are regressions, this PR will be reverted which I don't think would be correct.

Let me know if you agree, otherwise I will bump it 🙂

…y-App into hur/feat/log-network-response

allroundexperts

Looks good to me!

…y-App into hur/feat/log-network-response

hurali97 · 2024-07-31T13:30:12Z

Jest Unit Test is failing on CI because of some timeout issue. All tests passes on the local. Can we re-trigger the test?

…y-App into hur/feat/log-network-response

OSBotify · 2024-08-02T13:01:10Z

✋ 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-08-06T04:27:42Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.17-0 🚀

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

OSBotify · 2024-08-07T22:03:31Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T04:53:08Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T20:04:32Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

suneox · 2024-09-24T16:26:37Z

src/libs/Middleware/Logging.ts

+     * requests because they contain sensitive information.
+     */
+    if (request.command !== 'AuthenticatePusher') {
+        extraData.request = request;


This change raise regression issue #47509 when enable client log request data include has file can not store to indexdb, so we should serialize request data

hurali97 added 4 commits July 19, 2024 17:47

feat: log network response and request. Allow filtering option in Deb…

086e464

…ug Console

feat: add locale values for filter options

766f922

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

bf7e343

…y-App into hur/feat/log-network-response

feat: use correct icons

347f9b2

hurali97 added 6 commits July 24, 2024 17:21

feat: add filter option to debug console

c158a4a

feat: add extraData parameter for Logs

fa2d0b3

feat: clear the Logs onyx state each time the app is launched

7249b23

feat: Do not include request and response for Pusher authentication

eeb7f33

refactor: remove unused code

fe66ee1

feat: flush all logs on each app launch

46c3f78

hurali97 mentioned this pull request Jul 25, 2024

feat: add extraData parameter to info function Expensify/expensify-common#762

Merged

hurali97 added 2 commits July 26, 2024 15:05

feat: use correct filter icon and adjust the popup position for web a…

50fb3dc

…nd desktop

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

6cfde2b

…y-App into hur/feat/log-network-response

hurali97 marked this pull request as ready for review July 26, 2024 12:48

hurali97 requested review from a team as code owners July 26, 2024 12:48

melvin-bot bot removed the request for review from a team July 26, 2024 12:48

melvin-bot bot requested a review from allroundexperts July 26, 2024 12:48

hurali97 added 2 commits July 30, 2024 15:37

chore: bump expensify-common

5609006

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

13f5d28

…y-App into hur/feat/log-network-response

allroundexperts reviewed Jul 31, 2024

View reviewed changes

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

3971945

…y-App into hur/feat/log-network-response

allroundexperts approved these changes Jul 31, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath July 31, 2024 11:29

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

719f5c8

…y-App into hur/feat/log-network-response

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

db46ec7

…y-App into hur/feat/log-network-response

puneetlath approved these changes Aug 2, 2024

View reviewed changes

puneetlath merged commit 80b1c2f into Expensify:main Aug 2, 2024

muttmuure mentioned this pull request Aug 2, 2024

Hybrid app - App freezes when opening the reports showing as Hidden #44755

Closed

6 tasks

github-actions bot mentioned this pull request Aug 6, 2024

Deploy Checklist: New Expensify 2024-08-06 #46849

Closed

83 tasks

melvin-bot bot mentioned this pull request Aug 7, 2024

[HOLD for payment 2024-08-14] [Troubleshooting] Make it possible to export network queue #45275

Closed

suneox reviewed Sep 24, 2024

View reviewed changes

suneox mentioned this pull request Sep 24, 2024

[HOLD for payment 2024-09-16] [$250] Account Settings- App freezes after sending a log file #47509

Closed

6 tasks

Conversation

hurali97 commented Jul 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

muttmuure commented Jul 24, 2024

Uh oh!

hurali97 commented Jul 25, 2024

Uh oh!

melvin-bot bot commented Jul 26, 2024

Uh oh!

allroundexperts commented Jul 28, 2024

Uh oh!

allroundexperts commented Jul 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hurali97 commented Jul 29, 2024

Uh oh!

allroundexperts commented Jul 31, 2024

Uh oh!

allroundexperts Jul 31, 2024

Choose a reason for hiding this comment

Uh oh!

hurali97 Jul 31, 2024

Choose a reason for hiding this comment

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

hurali97 commented Jul 31, 2024

Uh oh!

OSBotify commented Aug 2, 2024

Uh oh!

OSBotify commented Aug 6, 2024

Uh oh!

OSBotify commented Aug 7, 2024

Uh oh!

OSBotify commented Aug 8, 2024

Uh oh!

OSBotify commented Aug 8, 2024

Uh oh!

suneox Sep 24, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hurali97 commented Jul 19, 2024 •

edited

Loading

allroundexperts commented Jul 28, 2024 •

edited

Loading