[NoQA] fix: real startup metric #39070

kirillzyusko · 2024-03-27T15:00:30Z

Details

Changed a place where we capture a metric according to 452595f but made it cross-platform.

How it affected TTI can be found below (captured in dev mode):

Before

{
  'App start nativeLaunch': [
     863,  919, 1081,  880,
     976,  878,  935, 1000,
    1111, 1032, 1101, 1164,
    1368, 1061, 1010, 1005,
    1080
  ],
  'App start regularAppStart': [
    0.7206630110740662, 0.7102870345115662,
    0.7419430017471313,  4.367106020450592,
    0.7322189807891846, 0.8898509740829468,
    0.9326990246772766, 0.7942700386047363,
    0.9451090097427368, 1.0676679611206055,
    0.7550860047340393, 0.8267410397529602,
    1.0378819704055786, 0.8785799741744995,
    1.0087479948997498, 0.7564700245857239,
    0.7955319881439209
  ],
  'App start runJsBundle': [
    5116, 5623, 5758, 7363,
    6115, 6145, 6820, 6084,
    6862, 7561, 6805, 6834,
    7409, 6988, 7056, 6831,
    5970
  ],
  'App start TTI': [
     11338.93211299181, 12159.524770975113,
     12636.31477600336,  29511.34791201353,
    12840.107114970684, 12998.940169990063,
    13401.366120994091, 13801.768064975739,
     14274.89665299654, 15361.110975980759,
    13998.597352027893, 14445.537382006645,
    15227.997309982777, 14070.840213000774,
    14286.960296988487, 14210.092343986034,
     12750.73859000206
  ],
  'App start jsBundleDownload': [
    1100, 1105, 1135, 1175,
    1174, 1154, 1175, 1176,
    1212, 1179, 1122, 1153,
    1183, 1180, 1162, 1173,
    1158
  ]
}
}

After

{
  compareEntries: undefined,
  baselineEntries: {
    'App start nativeLaunch': [
       726,  682, 671,  727,
       753,  891, 936,  839,
       897,  943, 996, 1016,
      1209, 1323, 943,  928,
      1067
    ],
    'App start TTI': [
       9180.628776013851,  9095.821936011314,
       8975.761027991772,  9565.689173996449,
      10251.910939991474, 11852.394060015678,
      12409.389752984047, 12952.296458005905,
      13160.995357990265, 13775.297976970673,
      13346.554168999195, 14187.704729020596,
      14563.292831003666,  15174.43627101183,
      13451.611326992512, 15328.591274023056,
      13972.332086026669
    ],
    'App start runJsBundle': [
      3758, 3803, 3910, 4059,
      4463, 5465, 5688, 5999,
      6099, 6854, 6118, 6779,
      6932, 7374, 6479, 6518,
      6686
    ],
    'App start regularAppStart': [
      0.5345460176467896, 0.5147709846496582,
      0.5024820566177368, 0.5381669998168945,
      0.6133219599723816, 0.6979569792747498,
       1.019327998161316,    0.8785400390625,
      0.9008379578590393, 0.6569010019302368,
      0.7740480303764343, 0.8857830166816711,
      0.8989670276641846, 0.8822020292282104,
      0.8953449726104736, 0.8267419934272766,
      0.8535969853401184
    ],
    'App start jsBundleDownload': [
      1147, 1141, 1163, 1130,
      1185, 1181, 1127, 1145,
      1139, 1166, 1208, 1186,
      1153, 1182, 1160, 1142,
      1136
    ]
  }
}

Fixed Issues

$ #35234 (comment)
PROPOSAL: #35234 (comment)

Tests

run e2e tests;
be sure that TTI metric still can be collected;
Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

run e2e tests;
be sure that TTI metric still can be collected;
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

kirillzyusko · 2024-03-27T15:28:21Z

@hurali97 may I ask you to check these changes? Are you happy to have them?

I've changed a code from your 452595f commit and made it cross-platform (I know that tests are running on Android only at the moment, but we plan to add more running platforms in the future so it's good to have already a cross-platform code in place).

Will be happy to hear your thoughts! 👀

hurali97 · 2024-03-28T08:05:33Z

Hey @kirillzyusko 👋

I agree with the idea of having the cross-platform code already in place. The only thing that I have a concern over is that we are calculating TTI and it gives us a number. This fulfils the requirement of measuring the TTI but if we want to see the break down of what areas took longest in the App startup lifecycle, we won't have a clue.

To help us in this we added markers to locate the start and stop of each part in the App startup lifecycle, see the below image which breaks down the App startup lifecycle in general:

These markers are added in this commit and if we add up these markers, we get the total value which is equal to what we get in TTI. So the idea is to measure TTI with it's own dedicated markers and also measure the metrics which makes up the App startup lifecycle, as discussed in this comment. Where we can see almost all of the time is spent in JS side by reading the value of contentAppeared_To_screenTTI from the table.

If we are not interested in finding out what took longer in the App startup lifecycle, we don't have to worry about adding these individual markers. Personally, I would prefer if I can have a sneak on what part of App startup lifecycle is causing the issues, while analysing the results reported by the tool.

The reason I emphasized on this is that it will be good to have this standardized what we record in e2e regression monitoring tool with what we will record in production with Grafana, so if we decide to only record TTI in e2e tool then we should only record and report TTI with Grafana 👍

kirillzyusko · 2024-03-28T11:18:35Z

@hurali97 thanks for a detailed explanation 🙌

I'm currently working on adding more markers. I opened this PR because I wanted to ship small PRs that solves a particular problem - so capturing a mark in different lifecycle (this PR) and adding more marks sounds like a different tasks.

Let me prepare then this PR for review (fix CI, update description, etc.) and then I'll roll out a PR with more markers 👍

melvin-bot · 2024-03-28T12:23:39Z

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

Pujan92 · 2024-03-28T17:48:35Z

src/Expensify.tsx

@@ -130,6 +131,7 @@ function Expensify({

    const onSplashHide = useCallback(() => {
        setIsSplashHidden(true);
+        Performance.markEnd(CONST.TIMING.SIDEBAR_LOADED);


On splash hide we are considering the sidebar loaded(ie. performance entry name SIDEBAR_LOADED), wondering if that is correct or name should be different? Asking bcoz earlier we did it in setSidebarLoaded.

@kirillzyusko I think I don't need to run the e2e test for this PR change, right?

@Pujan92 from one side - you are right, it's confusing that we use SIDEBAR_LOADED when splash screen gets hidden. But the start mark is added in BaseSidebar component (on mount).

So in my opinion it's better not to rename it 🙂

mountiny · 2024-03-29T22:33:53Z

@Pujan92 sorry I think think this will require C+ review

Pujan92 · 2024-03-30T11:48:12Z

@Pujan92 sorry I think think this will require C+ review

@mountiny Do you mean this won't require C+ review? Maybe not needed but adding a checklist to pass a check.

Pujan92 · 2024-04-02T09:18:54Z

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

mountiny

Sorry @Pujan92 I meant it wont need a C+ check

mountiny · 2024-04-02T11:44:23Z

Thanks for adding the checklist 🙇

OSBotify · 2024-04-02T11:51: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-04-08T10:55:50Z

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

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

fix: real startup metric

5bb5850

fix: prettier

71b12ac

kirillzyusko marked this pull request as ready for review March 28, 2024 12:23

kirillzyusko requested a review from a team as a code owner March 28, 2024 12:23

melvin-bot bot requested review from Pujan92 and removed request for a team March 28, 2024 12:23

Pujan92 reviewed Mar 28, 2024

View reviewed changes

mountiny assigned kirillzyusko Mar 29, 2024

mountiny changed the title ~~fix: real startup metric~~ [NoQA] fix: real startup metric Mar 29, 2024

mountiny self-requested a review March 29, 2024 22:34

Pujan92 approved these changes Apr 2, 2024

View reviewed changes

mountiny approved these changes Apr 2, 2024

View reviewed changes

mountiny merged commit a1801c8 into Expensify:main Apr 2, 2024
17 of 21 checks passed

github-actions bot mentioned this pull request Apr 4, 2024

[INCORRECT] (used to be a checklist but was incorrectly triggered) #39573

Closed

44 tasks

mountiny mentioned this pull request Apr 4, 2024

Deploy Checklist: New Expensify 2024-04-04 #39588

Closed

48 tasks

melvin-bot bot mentioned this pull request Apr 8, 2024

[HOLD for payment 2024-04-15] [Tracking] Metric - App Startup (Performance audit by Callstack) #35234

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] fix: real startup metric #39070

[NoQA] fix: real startup metric #39070

kirillzyusko commented Mar 27, 2024 •

edited

Loading

kirillzyusko commented Mar 27, 2024

hurali97 commented Mar 28, 2024

kirillzyusko commented Mar 28, 2024

melvin-bot bot commented Mar 28, 2024

Pujan92 Mar 28, 2024

Pujan92 Mar 29, 2024

kirillzyusko Apr 2, 2024

mountiny commented Mar 29, 2024

Pujan92 commented Mar 30, 2024 •

edited

Loading

Pujan92 commented Apr 2, 2024

mountiny left a comment

mountiny commented Apr 2, 2024

OSBotify commented Apr 2, 2024

OSBotify commented Apr 8, 2024

[NoQA] fix: real startup metric #39070

[NoQA] fix: real startup metric #39070

Conversation

kirillzyusko commented Mar 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kirillzyusko commented Mar 27, 2024

hurali97 commented Mar 28, 2024

kirillzyusko commented Mar 28, 2024

melvin-bot bot commented Mar 28, 2024

Pujan92 Mar 28, 2024

Choose a reason for hiding this comment

Pujan92 Mar 29, 2024

Choose a reason for hiding this comment

kirillzyusko Apr 2, 2024

Choose a reason for hiding this comment

mountiny commented Mar 29, 2024

Pujan92 commented Mar 30, 2024 • edited Loading

Pujan92 commented Apr 2, 2024

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Apr 2, 2024

OSBotify commented Apr 2, 2024

OSBotify commented Apr 8, 2024

kirillzyusko commented Mar 27, 2024 •

edited

Loading

Pujan92 commented Mar 30, 2024 •

edited

Loading