Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: re-enable performance metrics #598

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

hannojg
Copy link
Contributor

@hannojg hannojg commented Nov 18, 2024

Details

For this ticket:

We'd like to have the possibility to very granularly measure the performance of every onyx step during a user action in the newdot app.
In the past we had a performance utility which was removed during the typescript migration though:

This adds it "back" with a few differences though:

  • Had to be adapted to work with typescript
  • Also performance decorates function in OnyxUtils and Storage (this way we really get the full picture how long each sub step tool)
    • To enable this a new GlobalSettings was introduced into which utility functions can hook to optionally decorate their functions with performance measurements

The default setting is that we don't apply the performance decoration.

In NewDot we can simply use react-native-performance to read the performance entries from onyx.

Related Issues

Expensify/App#50652

Automated Tests

Internal dev tooling only

Manual Tests

I compiled the changes and tested them in newdot - nothing broke.

Author Checklist

  • I linked the correct issue in the ### Related 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 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 / Chrome
    • iOS / native
    • iOS / 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 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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 author 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

@hannojg hannojg marked this pull request as ready for review November 20, 2024 15:51
@hannojg hannojg requested a review from a team as a code owner November 20, 2024 15:51
@melvin-bot melvin-bot bot requested review from deetergp and removed request for a team November 20, 2024 15:52
@hannojg
Copy link
Contributor Author

hannojg commented Nov 20, 2024

@adhorodyski may i ask you to review please as we will use those changes together in newdot?

I tested and confirmed that we can use the performance entries recorded in Onyx in NewDot when using react-native-performance or the web performance API

lib/GlobalSettings.ts Outdated Show resolved Hide resolved
// @ts-expect-error Reassign
addAllSafeEvictionKeysToRecentlyAccessedList = decorateWithMetrics(addAllSafeEvictionKeysToRecentlyAccessedList, 'OnyxUtils.addAllSafeEvictionKeysToRecentlyAccessedList');
// @ts-expect-error Reassign
keysChanged = decorateWithMetrics(keysChanged, 'OnyxUtils.keysChanged');

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️ love this!!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i only hate the ts-expect-error suppressions 🤔

Copy link

@adhorodyski adhorodyski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like the changes, this is exactly what we wanted to achieve 😊 Thanks @hannojg!

deetergp
deetergp previously approved these changes Nov 25, 2024
@deetergp
Copy link
Contributor

@hannojg Code looks good to me, but it appears you have some merge conflicts.

@hannojg
Copy link
Contributor Author

hannojg commented Nov 25, 2024

Ah right; will update tomorrow, thanks for checking guys!

@hannojg
Copy link
Contributor Author

hannojg commented Nov 27, 2024

@deetergp this is good to be merged now 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants