fix: serialize request.data in logging middleware #47778

dominictb · 2024-08-21T10:19:04Z

Details

Fixed Issues

$ #47509
PROPOSAL: #47509 (comment)

Tests

Try to send a .txt file via any chat in NewDot app (Equivalently, enable Client Side Logging in Troubleshoot menu > View debug console > Share log)

Verify that there're no infinite errors occur in the console, the file is sent and the app function normally

Verify that no errors appear in the JS console

Offline tests

QA Steps

Try to send a .txt file via any chat in NewDot app (Equivalently, enable Client Side Logging in Troubleshoot menu > View debug console > Share log)

Verify that there're no infinite errors occur in the console, the file is sent and the app function normally

Verify that no errors appear in the JS console

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

compressed_android.webm.mp4

Android: mWeb Chrome

compressed_aweb.webm.mp4

iOS: Native

compressed_ios.mp4.mp4

iOS: mWeb Safari

compressed_iosweb.mp4.mp4

MacOS: Chrome / Safari

MacOS: Desktop

compressed_web.mov.mp4

melvin-bot · 2024-08-21T10:19:09Z

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

suneox · 2024-08-21T14:18:50Z

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

Screen.Recording.2024-08-28.at.23.49.37.mp4

Android: mWeb Chrome

Screen.Recording.2024-08-28.at.23.26.25.mp4

iOS: Native

Screen.Recording.2024-08-28.at.23.39.03.mp4

iOS: mWeb Safari

Screen.Recording.2024-08-28.at.23.39.03.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-29.at.00.39.05.mp4

Screen.Recording.2024-08-28.at.23.19.55.mp4

MacOS: Desktop

Screen.Recording.2024-08-28.at.23.23.11.mp4

suneox · 2024-08-23T01:53:11Z

src/libs/Middleware/Logging.ts

+    | (Record<string, never> | Set<Serializable>)
+    | (Record<string, never> | Serializable[]);
+
+function serializeValue(data: unknown) {


For logging, we store primitive data types, so we can simplify the logic of this function by using JSON.stringify with a replacer function can reduce to create a test for current change so we can just implement

JSON.parse(JSON.stringify(data, getCircularReplacer()))

Function getCircularReplacer

Noted. Working on this now.

suneox · 2024-08-28T17:34:33Z

src/libs/Middleware/Logging.ts

-        extraData.request = request;
+        extraData.request = {
+            ...request,
+            data: JSON.parse(JSON.stringify(request.data, getCircularReplacer())) as Record<string, unknown>,


NAB: Nice to have, we can move this logic into the function serializeLoggingValue.

suneox

LGTM, using JSON functionality can simplify the logic.

puneetlath · 2024-08-28T21:47:46Z

using JSON functionality can simplify the logic

Can you expand on what you mean by this? And if it would make the logic simpler, should we do it?

suneox · 2024-08-29T03:45:47Z

Can you expand on what you mean by this?

@puneetlath By using the JSON stringify/parse approach, we simplify the process of serializing complex objects and avoid custom recursive logic, rather than creating a new recursive function and manually handling various data types.

And if it would make the logic simpler, should we do it?

I think we should leverage the existing functions to make the code cleaner and more maintainable.

puneetlath · 2024-08-29T13:03:56Z

Ok let's do that then. What do you think @dominictb?

dominictb · 2024-08-30T02:10:28Z

@puneetlath @suneox updated.

puneetlath · 2024-08-30T14:24:40Z

Great. @suneox can you please re-review?

suneox · 2024-08-30T16:10:32Z

src/libs/Middleware/Logging.ts

+    };
+}
+
+function serializeLoggingData(logData?: Record<string, unknown> | null): Record<string, unknown> | undefined | null {


Nice to have support to keep the data type of object after serialization

Suggested change

function serializeLoggingData(logData?: Record<string, unknown> | null): Record<string, unknown> | undefined | null {

function serializeLoggingData<T extends Record<string, unknown>>(logData: T): T | null {

try {

return JSON.parse(JSON.stringify(logData, getCircularReplacer())) as T;

} catch (error) {

Log.hmmm('Failed to serialize log data', {error});

return null;

}

}

Hi @dominictb i've updated suggestion

Are we going to implement this suggestion?

@dominictb have you got any feedback on this suggestion?

Looking into this now

@suneox if we fail to serialize the data, shall we return dummy value like [Not serializable] or something? If we return the original data I'm afraid we could get into the original freeze issue again.

Ok I got it, so if fail to serialize data we can return null instead of original data

Cool, I'll update and let you know.

suneox · 2024-09-01T09:06:42Z

@dominictb Could you please update my suggested changes? It includes handling error. Once that’s done, I’ll approve it again. Thank you

suneox

LGTM

OSBotify · 2024-09-04T16:03:23Z

✋ 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-09-05T19:40:14Z

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

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

dominictb added 2 commits August 21, 2024 14:41

fix: serialize request.data in logging middleware

58f8d37

fix: update logging function

c5937f2

dominictb requested a review from a team as a code owner August 21, 2024 10:19

melvin-bot bot requested a review from suneox August 21, 2024 10:19

melvin-bot bot removed the request for review from a team August 21, 2024 10:19

suneox reviewed Aug 23, 2024

View reviewed changes

dominictb added 2 commits August 28, 2024 14:21

Merge branch 'main' into fix/47509-log-serialize

d642bf2

fix: new logic to serialize log

eae3c4c

suneox reviewed Aug 28, 2024

View reviewed changes

suneox approved these changes Aug 28, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath August 28, 2024 17:36

chore: create a shared function to serialize logging data

2e5134e

suneox reviewed Aug 30, 2024

View reviewed changes

dominictb added 2 commits September 4, 2024 19:48

Merge remote-tracking branch 'origin/main' into fix/47509-log-serialize

bf9b00e

fix: update serializeLogData function implementation

876adf8

puneetlath approved these changes Sep 4, 2024

View reviewed changes

suneox approved these changes Sep 4, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath September 4, 2024 15:33

puneetlath merged commit aae4c2e into Expensify:main Sep 4, 2024
17 checks passed

github-actions bot mentioned this pull request Sep 5, 2024

Deploy Checklist: New Expensify 2024-09-05 #48664

Closed

69 tasks

IuliiaHerets mentioned this pull request Sep 6, 2024

[HOLD for payment 2024-10-24] [$100] Attachment - Chat blinks when txt attachment is uploaded #48697

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: serialize request.data in logging middleware #47778

fix: serialize request.data in logging middleware #47778

dominictb commented Aug 21, 2024

melvin-bot bot commented Aug 21, 2024

suneox commented Aug 21, 2024 •

edited

Loading

suneox Aug 23, 2024 •

edited

Loading

dominictb Aug 27, 2024

suneox Aug 28, 2024

suneox left a comment

puneetlath commented Aug 28, 2024

suneox commented Aug 29, 2024

puneetlath commented Aug 29, 2024

dominictb commented Aug 30, 2024

puneetlath commented Aug 30, 2024

suneox Aug 30, 2024 •

edited

Loading

suneox Aug 30, 2024 •

edited

Loading

puneetlath Sep 3, 2024

suneox Sep 4, 2024

dominictb Sep 4, 2024

dominictb Sep 4, 2024

suneox Sep 4, 2024

dominictb Sep 4, 2024

dominictb Sep 4, 2024

suneox commented Sep 1, 2024

suneox left a comment

OSBotify commented Sep 4, 2024

OSBotify commented Sep 5, 2024

-function serializeLoggingData(logData?: Record<string, unknown> | null): Record<string, unknown> | undefined | null {
+function serializeLoggingData<T extends Record<string, unknown>>(logData: T): T | null {
+    try {
+        return JSON.parse(JSON.stringify(logData, getCircularReplacer())) as T;
+    } catch (error) {
+        Log.hmmm('Failed to serialize log data', {error});
+        return null;
+    }
+}

fix: serialize request.data in logging middleware #47778

fix: serialize request.data in logging middleware #47778

Conversation

dominictb commented Aug 21, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 21, 2024

suneox commented Aug 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

suneox Aug 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

suneox left a comment

Choose a reason for hiding this comment

puneetlath commented Aug 28, 2024

suneox commented Aug 29, 2024

puneetlath commented Aug 29, 2024

dominictb commented Aug 30, 2024

puneetlath commented Aug 30, 2024

suneox Aug 30, 2024 • edited Loading

Choose a reason for hiding this comment

suneox Aug 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

suneox commented Sep 1, 2024

suneox left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 4, 2024

OSBotify commented Sep 5, 2024

suneox commented Aug 21, 2024 •

edited

Loading

suneox Aug 23, 2024 •

edited

Loading

suneox Aug 30, 2024 •

edited

Loading

suneox Aug 30, 2024 •

edited

Loading