[NoQA] e2e: new common metrics (FPS, CPU, RAM) #43482

kirillzyusko · 2024-06-11T14:29:13Z

Details

Capture CPU, FPS and RAM for all tests.

Dev run (debug build, emulator, 8x runs):

Release run (release build, real device, 60x runs):

I also had to patch the new library - I opened the issue with all details bamlab/flashlight#291 (basically it was reproducible only on emulator, but I decided to keep the patch anyway because it improves the stability and maybe someone as me sometimes is running e2e tests on emulator too).

For second patch I created a PR to upstream: bamlab/flashlight#294

Fixed Issues

$ #19596
PROPOSAL: #19596 (comment)

Tests

Run e2e pipeline and be sure it's green and contains new metrics.

Offline tests

N/A

QA Steps

N/A

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

hannojg · 2024-06-17T04:17:41Z

One quick note: I see that all units are in ms. I think we should fix that, so the units can be different.

kirillzyusko · 2024-06-17T06:58:07Z

I think we should fix that, so the units can be different.

Yeah, I also noticed that, but decided that it will bring a lot of changes in a single PR, so probably it would be good to handle as a separate task 👀

I think main units will be:

ms
count (re-render)
% (CPU usage)
mb (RAM)
FPS (UI/JS) thread.

hannojg · 2024-06-17T07:45:01Z

How often did you ran the tests from the screenshot? We should run a full test run (I think these are 30x?) on a real device. We need to check if the values we get are stable.

kirillzyusko · 2024-06-17T08:50:37Z

@hannojg it was captured on debug build with dev config (x8 runs) on emulator. Below I attached a screenshot from a real device (my Pixel 7 Pro), 60x runs, release variant:

Metrics are very stable as you can see 👀 I'll update a description with a new screenshot 👍

melvin-bot · 2024-06-17T08:54:19Z

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

kirillzyusko · 2024-06-18T06:05:58Z

@hannojg @mountiny @alitoshmatov this one is ready for review 🙌

Feel free to have a look 👀

hannojg

overall looks good, just a few things to think about twice 😊

hannojg · 2024-06-18T08:10:36Z

patches/@perf-profiler+android+0.12.0.patch

+         const ram = processRamOutput(ramStr, this.getRAMPageSize());
+-        const { frameTimes, interval: atraceInterval } = frameTimeParser.getFrameTimes(atrace, pid);
+
+        let output;
+        try {
+          output = frameTimeParser.getFrameTimes(atrace, pid);
+        } catch (e) {
+          console.error(e);
+        }
+
+        if (!output) {
+          return;
+        }
+
+        const { frameTimes, interval: atraceInterval } = output;


do we need this patch, or was that just for your debugging?

If we need it, we need an upstream issue + PR please

@hannojg I already created it bamlab/flashlight#291 but haven't received any comments yet 🤔

ah awesome - I think we should add this to the PR description !

@hannojg done 😊

hannojg · 2024-06-18T08:10:52Z

tests/e2e/config.dev.ts

    MAIN_APP_PACKAGE: packageName,
    DELTA_APP_PACKAGE: packageName,
+    BRANCH_MAIN: 'main',
+    BRANCH_DELTA: 'main',
    MAIN_APP_PATH: appPath,
    DELTA_APP_PATH: appPath,


this is on purpose?

@hannojg yes. When we submit test result, then we specify branch and then we use the name of the branch to store the result.

Flashlight is running on the server, so we have to distinguish different builds (that's why I added BRANCH_MAIN/BRANCH_DELTA).

For dev config we run the same debug build (always main). That's why we specify main in both cases 🙂

tests/e2e/testRunner.ts

tests/e2e/utils/measure.ts

kirillzyusko · 2024-06-19T12:25:04Z

patches/@perf-profiler+reporter+0.8.1.patch

+ export * from "./utils/sanitizeProcessName";
+ export * from "./utils/round";
+ export * from "./reporting/cpu";
+export * from "./reporting/ram";


For that I created PR to upstream: bamlab/flashlight#294

kirillzyusko · 2024-06-20T09:49:45Z

Also added separate metrics for JS and UI thread. So now we track next metrics:

RAM usage
FPS average
CPU average
CPU usage for JS thread
CPU usage for UI thread

kirillzyusko · 2024-06-20T09:51:50Z

@alitoshmatov @mountiny this PR is ready for review 👀

mountiny

I do not think we need C+ review here. @hayata-suenaga do you want to review and add the checklist?

hayata-suenaga · 2024-06-24T01:59:15Z

tests/e2e/utils/measure.ts

+
+let measures: Measure[] = [];
+let polling = {
+    stop: (): void => {


When will this version of the method callled?

I can see that the pulling is assigned a value inside start, but will the stop method change to this original definition when the profiler is stopped?

You're right, I added missing code in 7b1994b 🙌

hayata-suenaga · 2024-06-24T03:25: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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

hayata-suenaga · 2024-06-24T03:26:53Z

Just one question, but other than that, the code looks good to me!

mountiny · 2024-06-24T12:44:36Z

I think this is ready for another look @hayata-suenaga

kirillzyusko · 2024-06-25T16:13:50Z

@hayata-suenaga just a friendly reminder 😊

hayata-suenaga · 2024-06-26T05:59:45Z

sorry I have been on and off with travel sickness. I'm reviewing this now 🙇

kirillzyusko · 2024-06-26T07:32:24Z

@hayata-suenaga okay, sure 🙌 🙂

hayata-suenaga

the change looks good to me 🟢 sorry for the late review 🙇

OSBotify · 2024-06-27T04:42:19Z

✋ 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-07-03T19:37:30Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

OSBotify · 2024-07-10T10:55:29Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

kirillzyusko force-pushed the e2e/common-metrics branch from 507a0c3 to 53b6269 Compare June 11, 2024 14:30

kirillzyusko changed the title ~~[WIP] e2e: new common metrics (FPS, CPU, RAM)~~ [NoQA] e2e: new common metrics (FPS, CPU, RAM) Jun 17, 2024

kirillzyusko marked this pull request as ready for review June 17, 2024 08:54

kirillzyusko requested a review from a team as a code owner June 17, 2024 08:54

melvin-bot bot requested review from alitoshmatov and removed request for a team June 17, 2024 08:54

hannojg reviewed Jun 18, 2024

View reviewed changes

kirillzyusko mentioned this pull request Jun 18, 2024

[NoQA] e2e: support for different units #43890

Merged

49 tasks

kirillzyusko commented Jun 19, 2024

View reviewed changes

kirillzyusko force-pushed the e2e/common-metrics branch from 8475499 to 043e362 Compare June 20, 2024 07:42

mountiny assigned kirillzyusko Jun 20, 2024

mountiny requested a review from hayata-suenaga June 20, 2024 12:11

mountiny previously approved these changes Jun 20, 2024

View reviewed changes

hayata-suenaga reviewed Jun 24, 2024

View reviewed changes

kirillzyusko mentioned this pull request Jun 24, 2024

perf: improve native apps startup #44068

Merged

50 tasks

kirillzyusko added 5 commits June 24, 2024 10:38

e2e: new common metrics (FPS, CPU, RAM)

948253f

fix: don't include warmup results into final report

523ad7a

fix: crash if can not parse a frame

4ee79b7

fix: port changes to compiled js file

ca8e0d1

fix: TS compilation

e053fa6

kirillzyusko added 3 commits June 24, 2024 10:39

fix: don't add results to delta if we run dev build

eda73ca

chore: fixes after code review

f178843

feat: JS and UI thread metrics added

eeaa464

kirillzyusko dismissed mountiny’s stale review via eeaa464 June 24, 2024 07:39

kirillzyusko force-pushed the e2e/common-metrics branch from 7202a82 to eeaa464 Compare June 24, 2024 07:39

chore: changes after review

7b1994b

hayata-suenaga approved these changes Jun 27, 2024

View reviewed changes

hayata-suenaga merged commit d4e82ac into Expensify:main Jun 27, 2024
18 checks passed

This was referenced Jun 27, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #44522

Closed

Deploy Checklist: New Expensify 2024-06-27 #44575

Closed

kirillzyusko mentioned this pull request Jun 28, 2024

[NoQA] chore: remove profiler patches #44630

Merged

49 tasks

melvin-bot bot mentioned this pull request Jul 3, 2024

[HOLD for payment 2024-07-10] Implement Flashlight tool to the testing suite #19596

Closed

kirillzyusko mentioned this pull request Jul 18, 2024

[NoQA] chore: remove last perf-profiler patch #45662

Merged

49 tasks

kirillzyusko mentioned this pull request Aug 2, 2024

[NoQA] e2e: add lowerIsBetter for e2e metrics #46732

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] e2e: new common metrics (FPS, CPU, RAM) #43482

[NoQA] e2e: new common metrics (FPS, CPU, RAM) #43482

kirillzyusko commented Jun 11, 2024 •

edited

Loading

hannojg commented Jun 17, 2024

kirillzyusko commented Jun 17, 2024

hannojg commented Jun 17, 2024

kirillzyusko commented Jun 17, 2024

melvin-bot bot commented Jun 17, 2024

kirillzyusko commented Jun 18, 2024

hannojg left a comment

hannojg Jun 18, 2024

kirillzyusko Jun 18, 2024

hannojg Jun 18, 2024

kirillzyusko Jun 19, 2024

hannojg Jun 18, 2024

kirillzyusko Jun 18, 2024

kirillzyusko Jun 19, 2024

kirillzyusko commented Jun 20, 2024

kirillzyusko commented Jun 20, 2024

mountiny left a comment

hayata-suenaga Jun 24, 2024

kirillzyusko Jun 24, 2024

hayata-suenaga commented Jun 24, 2024 •

edited

Loading

hayata-suenaga commented Jun 24, 2024

mountiny commented Jun 24, 2024

kirillzyusko commented Jun 25, 2024

hayata-suenaga commented Jun 26, 2024

kirillzyusko commented Jun 26, 2024

hayata-suenaga left a comment

OSBotify commented Jun 27, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 10, 2024

[NoQA] e2e: new common metrics (FPS, CPU, RAM) #43482

[NoQA] e2e: new common metrics (FPS, CPU, RAM) #43482

Conversation

kirillzyusko commented Jun 11, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hannojg commented Jun 17, 2024

kirillzyusko commented Jun 17, 2024

hannojg commented Jun 17, 2024

kirillzyusko commented Jun 17, 2024

melvin-bot bot commented Jun 17, 2024

kirillzyusko commented Jun 18, 2024

hannojg left a 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

Choose a reason for hiding this comment

kirillzyusko commented Jun 20, 2024

kirillzyusko commented Jun 20, 2024

mountiny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hayata-suenaga commented Jun 24, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hayata-suenaga commented Jun 24, 2024

mountiny commented Jun 24, 2024

kirillzyusko commented Jun 25, 2024

hayata-suenaga commented Jun 26, 2024

kirillzyusko commented Jun 26, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 27, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 10, 2024

kirillzyusko commented Jun 11, 2024 •

edited

Loading

hayata-suenaga commented Jun 24, 2024 •

edited

Loading