Skip to content

Extend request-phase telemetry spans to Search - #98577

Draft
TMisiukiewicz wants to merge 12 commits into
Expensify:mainfrom
callstack-internal:perf/search-request-phase-telemetry
Draft

Extend request-phase telemetry spans to Search#98577
TMisiukiewicz wants to merge 12 commits into
Expensify:mainfrom
callstack-internal:perf/search-request-phase-telemetry

Conversation

@TMisiukiewicz

@TMisiukiewicz TMisiukiewicz commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

This is a follow-up to and is stacked on #98413. That PR added four spans splitting the OpenApp/ReconnectApp data load into StartupData.Wait / .Download / .Apply / .Render. The instrumentation itself is command-agnostic — the only thing making it startup-specific was the APP_STARTUP_NETWORK_REQUEST.has(command) gate. This PR widens that gate to also cover READ_COMMANDS.SEARCH and gives Search its own span family so the two don't share names or attempt counters.

Stacked on #98413. That PR is not merged yet and its branch only exists on the fork, so GitHub cannot render this as a stacked diff — the diff below includes #98413's changes. Review only the files listed under "New in this PR"; everything else belongs to #98413 and is reviewed there.

Merge order: this should not be merged before #98413. Once #98413 lands, this branch should be rebased onto main so the diff collapses to just the files above.

Span table:

Span Starts Ends Measures
SearchData.Queue search() entry, before waitForWrites write queue idle time blocked behind pending write commands
SearchData.Wait fetch() response headers server think time (TTFB)
SearchData.Download response headers response.json() resolves transfer + parse
SearchData.Apply response resolves middleware chain done Onyx snapshot write
SearchData.Render Onyx apply resolves two frames under 32ms render cascade after the snapshot lands

Key design decisions:

  1. The attempt counter is keyed per span name, not global, so a concurrent Search can't shift the attempt numbers a startup span reports.
  2. request_id (the server's requestID, available only once the body is parsed) lands on Download, Apply, and StartupData.Render

Known limits:

  • SearchData.Queue is absent for searches using skipWaitForWrites (home-screen sections, post-expense flow) — those never open one.
  • SearchData.Wait carries no request_id; the ID arrives with the body. Reach it via the paired Download span.
  • The Queue span id is SearchData.Queue_${hash}_${offset}, reused across time. Safe only because the existing in-flight dedupe prevents two searches with the same key overlapping.
  • Search needs its own Render span because ManualNavigateToReportsContentLoad only covers the Reports tab tap (startNavigateToReportsSpans() has one caller, SearchTabButton.tsx:50) — pagination, in-page re-search, and view switches re-run the list render with no measurement otherwise. It measures JS-thread-busy time after apply, not time-to-content: a quiet gap of two or more frames mid-cascade closes it early, so read the duration as a floor and longest_frame_ms as the actionable number. Filter on timed_out: false.

Fixed Issues

$ #98442
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Same as tests

  • 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 followed proper code patterns (see Reviewing the code)
    • 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 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)
  • 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)
  • 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.
  • 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

@github-actions

Copy link
Copy Markdown
Contributor

🚧 mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
Built from App PR #98577.

Android 🤖 iOS 🍎
⏩ SKIPPED ⏩ ⏩ SKIPPED ⏩
The build for Android was skipped The build for iOS was skipped
Web 🕸️
https://98577.pr-testing.expensify.com
Web

👀 View the workflow run that generated this build 👀

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.

1 participant