feat: web profiler v2 #46133

kirillzyusko · 2024-07-24T16:58:38Z

Details

Added an ability to profile web release apps.

Better revision of #44432

Warning

You'll need to add 'Document-Policy': 'js-profiling' to responses to make profiler working.

Fixed Issues

$ #43363
PROPOSAL: N/A

Tests

Press cmd+d to open popup
Toggle "Use profiling"
Record interactions
Press cmd+d to open popup
Toggle "Use profiling"
symbolicate profiling trace
open is speedscope.app

Offline tests

N/A

QA Steps

be sure fonts are the same between staging app and app from this PR ([HOLD for payment 2024-08-02] [HOLD for payment 2024-08-01] Desktop - App - App font is different on staging #46048);

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-07-25T09:50:17Z

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

jayeshmangwani · 2024-07-29T07:27:19Z

.github/workflows/platformDeploy.yml

@@ -179,6 +179,12 @@ jobs:
        env:
          GITHUB_TOKEN: ${{ github.token }}

+      - name: Archive desktop sourcemaps
+        uses: actions/upload-artifact@v3


Not sure if we should use v3 here, as for every action we are using upload-artifact v4

jayeshmangwani · 2024-07-29T08:58:34Z

README.md

  Android: `android/app/build/generated/sourcemaps/react/productionRelease/index.android.bundle.map`
  IOS: `main.jsbundle.map`
+  web: `dist/merged-source-map.js.map`


Noob question: Why haven't we added the desktop/dist/www/merged-source-map.js.map path here for desktop?

@jayeshmangwani I think because the code for web and desktop is identical. At least when I was trying to profile desktop app using web source map everything was well, i. e. I could see all stack-traces correctly

jayeshmangwani · 2024-07-31T21:19:42Z

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.mov

Android: mWeb Chrome

349098907-a1fd2067-7c3e-4aa7-8a53-ffdca1dc23cd.mov

iOS: Native

iOS.mov

iOS: mWeb Safari

mWeb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

jayeshmangwani

lgtm

stitesExpensify · 2024-08-01T21:48:30Z

Code looks good but there are conflicts now

…release-profiler-on-web"" This reverts commit d50f007.

kirillzyusko · 2024-08-02T08:35:03Z

@stitesExpensify I resolved them 😊 Would you mind to check again? 👀

OSBotify · 2024-08-02T16:52:29Z

✋ 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:50Z

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

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

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

🚀 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:17Z

🚀 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:41Z

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

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

kirillzyusko marked this pull request as ready for review July 25, 2024 09:50

kirillzyusko requested a review from a team as a code owner July 25, 2024 09:50

melvin-bot bot requested review from jayeshmangwani and removed request for a team July 25, 2024 09:50

jayeshmangwani reviewed Jul 29, 2024

View reviewed changes

kirillzyusko force-pushed the feat/web-profiler-v2 branch from ccaa4e3 to 24e8175 Compare July 31, 2024 11:28

jayeshmangwani approved these changes Jul 31, 2024

View reviewed changes

melvin-bot bot requested a review from stitesExpensify July 31, 2024 21:20

stitesExpensify previously approved these changes Aug 1, 2024

View reviewed changes

kirillzyusko added 4 commits August 2, 2024 10:33

Revert "Revert "Merge pull request Expensify#44432 from margelo/feat/…

8e8e963

…release-profiler-on-web"" This reverts commit d50f007.

fix: mime types

ce58e7c

fix: eslint

b283fff

fix: use v4 for uploading artifact

beaa576

kirillzyusko dismissed stitesExpensify’s stale review via beaa576 August 2, 2024 08:34

kirillzyusko force-pushed the feat/web-profiler-v2 branch from 24e8175 to beaa576 Compare August 2, 2024 08:34

stitesExpensify approved these changes Aug 2, 2024

View reviewed changes

stitesExpensify merged commit 63e5fe1 into Expensify:main Aug 2, 2024
19 checks passed

This was referenced Aug 5, 2024

[HOLD for payment 2024-08-14] [$250] MEDIUM: [Debugability] Add profile trace download option to Desktop and Web #43363

Closed

Add Profiling to mobile web debug options #46812

Closed

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

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

Closed

83 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: web profiler v2 #46133

feat: web profiler v2 #46133

kirillzyusko commented Jul 24, 2024 •

edited

Loading

melvin-bot bot commented Jul 25, 2024

jayeshmangwani Jul 29, 2024

jayeshmangwani Jul 29, 2024

kirillzyusko Jul 31, 2024

jayeshmangwani commented Jul 31, 2024

jayeshmangwani left a comment

stitesExpensify commented Aug 1, 2024

kirillzyusko commented Aug 2, 2024

OSBotify commented Aug 2, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

feat: web profiler v2 #46133

feat: web profiler v2 #46133

Conversation

kirillzyusko commented Jul 24, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 25, 2024

jayeshmangwani Jul 29, 2024

Choose a reason for hiding this comment

jayeshmangwani Jul 29, 2024

Choose a reason for hiding this comment

kirillzyusko Jul 31, 2024

Choose a reason for hiding this comment

jayeshmangwani commented Jul 31, 2024

Reviewer Checklist

Screenshots/Videos

jayeshmangwani left a comment

Choose a reason for hiding this comment

stitesExpensify commented Aug 1, 2024

kirillzyusko commented Aug 2, 2024

OSBotify commented Aug 2, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

kirillzyusko commented Jul 24, 2024 •

edited

Loading