Skip to content

[NoQA][Sentry] Adds a metric with effective render time of Reports tab#79455

Merged
rlinoz merged 7 commits intoExpensify:mainfrom
callstack-internal:sentry/effective-reports-render
Jan 15, 2026
Merged

[NoQA][Sentry] Adds a metric with effective render time of Reports tab#79455
rlinoz merged 7 commits intoExpensify:mainfrom
callstack-internal:sentry/effective-reports-render

Conversation

@leshniak
Copy link
Contributor

Explanation of Change

The current metric ManualNavigateToReportsTab includes the time of API requests, which incorporates all network-related conditions into the metric. Although it is a good overall measure of UX, it is a noisy metric for tracking UI issues. This metric measures the time between the points when we already have the data and when we actually display them to the user, to provide a better picture for further analysis.

Fixed Issues

$ #77174
PROPOSAL:

Tests

I've checked using console.log if these points actually measures the desired time.

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • Verify that no errors appear in the JS console

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
  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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

Copilot AI review requested due to automatic review settings January 13, 2026 12:14
@leshniak leshniak requested review from a team as code owners January 13, 2026 12:14
@github-actions
Copy link
Contributor

github-actions bot commented Jan 13, 2026

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a new Sentry metric ManualOnLayoutContentReports to measure the effective render time of the Reports tab, specifically tracking the time between when data is available and when it's actually displayed to the user. This provides a cleaner metric for UI performance analysis compared to the existing ManualNavigateToReportsTab metric, which includes network request time.

Changes:

  • Added new telemetry constant SPAN_ON_LAYOUT_CONTENT_REPORTS
  • Implemented span lifecycle management in the Search component: started when skeleton completes rendering, ended when actual content renders
  • Added cancel calls for the new span in all error/empty state paths

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/CONST/index.ts Adds the new telemetry span constant SPAN_ON_LAYOUT_CONTENT_REPORTS
src/components/Search/index.tsx Implements span lifecycle: starts in onLayoutSkeleton, ends in onLayout, and cancels in error/empty paths

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +956 to +959
startSpan(CONST.TELEMETRY.SPAN_ON_LAYOUT_CONTENT_REPORTS, {
name: CONST.TELEMETRY.SPAN_ON_LAYOUT_CONTENT_REPORTS,
op: CONST.TELEMETRY.SPAN_ON_LAYOUT_CONTENT_REPORTS,
});
Copy link

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

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

The span SPAN_ON_LAYOUT_CONTENT_REPORTS is only started in onLayoutSkeleton, which is only called when shouldShowLoadingState is true (line 962). However, if the data is already loaded when the component renders and shouldShowLoadingState is false from the start, the skeleton is never shown, onLayoutSkeleton is never called, and this span is never started. Yet the onLayout callback on line 950 will still try to end this span. This means the metric won't be captured in scenarios where data loads quickly or is already cached, which could be a significant portion of user interactions.

Consider starting the span earlier in the component lifecycle (e.g., where SPAN_ON_LAYOUT_SKELETON_REPORTS is started in NavigationTabBar) or conditionally starting it in the normal render path when shouldShowLoadingState is false, to ensure the metric is captured in all cases.

Copilot uses AI. Check for mistakes.
@codecov
Copy link

codecov bot commented Jan 13, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/CONST/index.ts 83.76% <ø> (ø)
...c/components/Navigation/NavigationTabBar/index.tsx 50.00% <0.00%> (ø)
src/components/Search/index.tsx 35.04% <42.85%> (+0.13%) ⬆️
... and 5 files with indirect coverage changes

@leshniak leshniak force-pushed the sentry/effective-reports-render branch 2 times, most recently from e424710 to 5e7174c Compare January 13, 2026 13:07
@leshniak leshniak force-pushed the sentry/effective-reports-render branch from 5e7174c to 4134d24 Compare January 13, 2026 13:27
@leshniak
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

CLABotify added a commit to Expensify/CLA that referenced this pull request Jan 13, 2026
@joekaufmanexpensify
Copy link
Contributor

No product considerations. Removing my review

@joekaufmanexpensify joekaufmanexpensify removed their request for review January 13, 2026 17:11
@huult
Copy link
Contributor

huult commented Jan 14, 2026

It looks like Reassure Performance Tests / perf-tests (pull_request) is failing. Please try merging main to fix it.

Ping me when this PR is ready.

@leshniak
Copy link
Contributor Author

@huult done. The check looks fine now.

@huult
Copy link
Contributor

huult commented Jan 14, 2026

@leshniak Please resolve the conflict.

@huult
Copy link
Contributor

huult commented Jan 14, 2026

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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: HybridApp
Screen.Recording.2026-01-15.at.10.39.05.mp4
Android: mWeb Chrome
Screen.Recording.2026-01-15.at.10.37.56.mp4
iOS: HybridApp
Screen.Recording.2026-01-15.at.10.42.04.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2026-01-15.at.09.59.26.mp4

inputQuery: queryJSON?.inputQuery,
});
}
}, [shouldShowLoadingState]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
}, [shouldShowLoadingState]);
// Exclude `queryJSON?.inputQuery` since it’s only telemetry metadata and would cause the span to start multiple times.
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [shouldShowLoadingState]);

Please add // eslint-disable-next-line react-hooks/exhaustive-deps if we intentionally don’t want to add queryJSON?.inputQuery to the dependency array, and add a comment explaining why this rule is disabled.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@huult
Copy link
Contributor

huult commented Jan 15, 2026

Screen.Recording.2026-01-15.at.09.59.26.mov

It looks like it works. Currently, we measure the duration only when data is available, empty and error states are skipped.

@leshniak
Copy link
Contributor Author

I've addressed the comments, conflicts are fixed too.

@rlinoz rlinoz requested a review from huult January 15, 2026 12:04
Copy link
Contributor

@huult huult left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from rlinoz January 15, 2026 12:12
@huult
Copy link
Contributor

huult commented Jan 15, 2026

@leshniak please resovle the conflict

@leshniak
Copy link
Contributor Author

@leshniak please resovle the conflict

Resolved

@rlinoz rlinoz merged commit b1e6af2 into Expensify:main Jan 15, 2026
29 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.3.3-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.3.3-8 🚀

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

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.

6 participants