[NoQA] fix: timing measurements are inaccurate #48654

hannojg · 2024-09-05T15:17:46Z

Details

I noticed that we postpone ending our timing measurements only when the getEnvironment() promise resolves.
I had a case where I manually measured that a function only takes 0.17ms, but the timing library was printing in the logs it would take 17ms.
After changing to a more high precision timer using performance.now() instead of Date.now() and moving the end of the timer mark out of the promise I started to see correct performance measurement values.

Fixed Issues

$ #48653
PROPOSAL:

Tests

Make sure that in the console you still see the [TIMING] logs.

Offline tests

Same as tests

QA Steps

Make sure that in the console you still see the [TIMING] logs.

PR Author Checklist

Screenshots/Videos

Android: Native

(Note: as this is internal dev tooling changes, I skipped recording tests for every platform)
https://github.com/user-attachments/assets/07c99888-aced-4d41-a63c-130886f4af24

Android: mWeb Chrome

(Note: as this is internal dev tooling changes, I skipped recording tests for every platform)
https://github.com/user-attachments/assets/07c99888-aced-4d41-a63c-130886f4af24

iOS: Native

(Note: as this is internal dev tooling changes, I skipped recording tests for every platform)
https://github.com/user-attachments/assets/07c99888-aced-4d41-a63c-130886f4af24

iOS: mWeb Safari

(Note: as this is internal dev tooling changes, I skipped recording tests for every platform)
https://github.com/user-attachments/assets/07c99888-aced-4d41-a63c-130886f4af24

MacOS: Chrome / Safari

(Note: as this is internal dev tooling changes, I skipped recording tests for every platform)
https://github.com/user-attachments/assets/07c99888-aced-4d41-a63c-130886f4af24

MacOS: Desktop

(Note: as this is internal dev tooling changes, I skipped recording tests for every platform)
https://github.com/user-attachments/assets/07c99888-aced-4d41-a63c-130886f4af24

melvin-bot · 2024-09-05T15:29:54Z

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

eh2077 · 2024-09-05T16:17:48Z

src/libs/actions/Timing.ts


+    const eventTime = performance.now() - startTime;


NAB: Is it better not to count Firebase.startTrace(eventName) and Firebase.stopTrace(eventName) in the eventTime? Though both of them look lightweight.

ah, good point - for Firebase.startTrace its already the case, I changed it to be also the case for stopTrace!

for Firebase.startTrace its already the case

Hmm, but we should get startTime after Firebase.startTrace right?

yes, that makes sense as well! I think now we got it 😄

ah sorry i think i committed to the wrong branch, one sec

eh2077 · 2024-09-05T17:13:19Z

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

0-android.mp4

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

eh2077

LGTM

melvin-bot · 2024-09-06T11:30:35Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #48653 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

marcaaron

LGTM

OSBotify · 2024-09-06T21:12:31Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

luacmartins · 2024-09-09T20:50:53Z

FYI we started seeing App crashes after this PR was merged. I'm preventing the crash by making the changes here, but that doesn't fix the root cause in which traceMap is an empty object when we call stopTrace. Could you please look into it?

eh2077 · 2024-09-16T12:23:25Z

@hannojg This PR has been reverted for causing crashes. Would you like to take a look into that?

hannojg · 2024-09-24T07:22:25Z

Sorry, was OOO, but now I am back. Yes, let me make a fix for the root cause!

hannojg · 2024-10-03T15:09:55Z

Actually after looking more closely into this i think the fix @luacmartins deployed is good!

eh2077 · 2024-10-10T15:55:38Z

@luacmartins May I know am I eligible for payment for reviewing this PR?

This one is special

I helped review it though there's a [NoQA] tag
It caused a DB
You fixed it and I wasn't involved in reviewing your PR

That said, whatever the team think is best works for me, thanks.

cc @marcaaron

luacmartins · 2024-10-10T16:02:32Z

@eh2077 I reopened the issue to process payment. Thanks for bringing this up.

fix: timing measurements are inaccurate

d199c5e

hannojg marked this pull request as ready for review September 5, 2024 15:29

hannojg requested a review from a team as a code owner September 5, 2024 15:29

melvin-bot bot requested review from eh2077 and removed request for a team September 5, 2024 15:29

hannojg changed the title ~~fix: timing measurements are inaccurate~~ [NoQA] fix: timing measurements are inaccurate Sep 5, 2024

hannojg mentioned this pull request Sep 5, 2024

[HOLD for payment 2024-10-10] Timing measurements are not exact #48653

Closed

eh2077 reviewed Sep 5, 2024

View reviewed changes

hannojg added 2 commits September 5, 2024 19:42

call performance.now() before calling Firebase.stopTrace

c3332ab

call performance.now() after calling firebase

340ce91

eh2077 approved these changes Sep 6, 2024

View reviewed changes

marcaaron approved these changes Sep 6, 2024

View reviewed changes

marcaaron merged commit 4bbe332 into Expensify:main Sep 6, 2024
17 checks passed

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

Deploy Checklist: New Expensify 2024-09-09 #48791

Closed

blimpich mentioned this pull request Sep 9, 2024

[HOLD for payment 2024-09-18] Android&iOS - App crashes after uploading a new build #48799

Closed

6 tasks

luacmartins mentioned this pull request Sep 9, 2024

Revert "[NoQA] fix: timing measurements are inaccurate" #48805

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] fix: timing measurements are inaccurate #48654

[NoQA] fix: timing measurements are inaccurate #48654

hannojg commented Sep 5, 2024 •

edited

Loading

melvin-bot bot commented Sep 5, 2024

eh2077 Sep 5, 2024

hannojg Sep 5, 2024

eh2077 Sep 6, 2024

hannojg Sep 6, 2024

hannojg Sep 6, 2024

hannojg Sep 6, 2024

eh2077 commented Sep 5, 2024 •

edited

Loading

eh2077 left a comment

melvin-bot bot commented Sep 6, 2024

marcaaron left a comment

OSBotify commented Sep 6, 2024

luacmartins commented Sep 9, 2024

eh2077 commented Sep 16, 2024

hannojg commented Sep 24, 2024

hannojg commented Oct 3, 2024

eh2077 commented Oct 10, 2024

luacmartins commented Oct 10, 2024

[NoQA] fix: timing measurements are inaccurate #48654

[NoQA] fix: timing measurements are inaccurate #48654

Conversation

hannojg commented Sep 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 5, 2024

eh2077 Sep 5, 2024

Choose a reason for hiding this comment

hannojg Sep 5, 2024

Choose a reason for hiding this comment

eh2077 Sep 6, 2024

Choose a reason for hiding this comment

hannojg Sep 6, 2024

Choose a reason for hiding this comment

hannojg Sep 6, 2024

Choose a reason for hiding this comment

hannojg Sep 6, 2024

Choose a reason for hiding this comment

eh2077 commented Sep 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eh2077 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 6, 2024

marcaaron left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 6, 2024

luacmartins commented Sep 9, 2024

eh2077 commented Sep 16, 2024

hannojg commented Sep 24, 2024

hannojg commented Oct 3, 2024

eh2077 commented Oct 10, 2024

luacmartins commented Oct 10, 2024

hannojg commented Sep 5, 2024 •

edited

Loading

eh2077 commented Sep 5, 2024 •

edited

Loading