Skip to content

[No QA] Add Sentry performance spans to the networking pipeline#82731

Merged
roryabraham merged 25 commits intomainfrom
rory-network-sentry-spans
Feb 20, 2026
Merged

[No QA] Add Sentry performance spans to the networking pipeline#82731
roryabraham merged 25 commits intomainfrom
rory-network-sentry-spans

Conversation

@roryabraham
Copy link
Contributor

@roryabraham roryabraham commented Feb 18, 2026

Explanation of Change

Adds Sentry performance spans across the E/App networking pipeline to enable identification of performance bottlenecks and regressions in the request lifecycle. This instruments:

  • SequentialQueue (flush, process, flushOnyxUpdatesQueue) — measures full queue processing cycles and per-request timing
  • Middleware pipeline (processWithMiddleware, processMiddlewares, makeXHR) — three-level hierarchy separating network I/O from middleware processing
  • All 9 middlewares — auto-wrapped via a modified addMiddleware(middleware, name) so each middleware gets its own child span under processMiddlewares
  • OnyxUpdates (applyHTTPSOnyxUpdates, applyPusherOnyxUpdates, applyAirshipOnyxUpdates) — measures Onyx update application alongside existing Performance.markStart/End
  • RequestThrottle.sleep — measures retry backoff duration
  • Optimistic data application in prepareRequest() — measures time to apply optimistic updates before network calls
  • OnyxUpdateManager.handleMissingOnyxUpdates — measures the full gap-handling flow that blocks the SequentialQueue

The span hierarchy for a write request flush cycle looks like:

SequentialQueue.flush
  +-- SequentialQueue.process[command]
  |     +-- processWithMiddleware
  |     |     +-- HttpUtils.xhr           (network I/O)
  |     |     +-- processMiddlewares      (aggregate middleware cost)
  |     |           +-- Middleware: Logging
  |     |           +-- Middleware: RecheckConnection
  |     |           +-- ... (all 9 middlewares)
  |     +-- RequestThrottle.sleep         (only on retry path)
  +-- flushOnyxUpdatesQueue

All spans follow the existing Manual* naming convention and include command attributes for Sentry dashboard slicing.

Fixed Issues

N/A — internal performance instrumentation, no linked issue.

Tests

  1. Set ENABLE_SENTRY_ON_DEV=true in .env, run npm run web
  2. Go to settings -> troubleshoot -> enable sentry logging
  3. Open the browser console and ensure that you have verbose (debug) logs enabled
  4. Perform actions that trigger the SequentialQueue (send a message, create an expense)
  5. Check browser console for Sentry transaction envelopes containing new span names (ManualSequentialQueueFlush, ManualSequentialQueueProcess, middleware.Logging, etc.) Sentry logs begin with [SENTRY]
  • Verify that no errors appear in the JS console

Offline tests

N/A — these spans are no-ops when Sentry is not initialized (offline, test environments). The SequentialQueue and middleware behavior is unchanged.

QA Steps

No QA — this PR adds observability instrumentation only. No user-facing behavior changes. Spans are no-ops when Sentry is not initialized.

  • 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

image image

roryabraham and others added 8 commits February 17, 2026 18:12
Co-authored-by: Cursor <cursoragent@cursor.com>
…tesQueue

Co-authored-by: Cursor <cursoragent@cursor.com>
…R, and auto-wrap all middlewares

Introduces a three-level span hierarchy inside processWithMiddleware:
- processWithMiddleware (outermost, full pipeline)
  - HttpUtils.xhr (network I/O)
  - processMiddlewares (aggregate middleware cost)
    - individual middleware spans (auto-wrapped via addMiddleware)

The addMiddleware function now accepts a name parameter used to
create per-middleware child spans under processMiddlewares.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
- Type catch block error as unknown and use instanceof Error
- Add required name parameter to addMiddleware calls in MiddlewareTest.ts

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham roryabraham self-assigned this Feb 18, 2026
roryabraham and others added 2 commits February 19, 2026 10:14
… value

If a middleware doesn't return a promise (returns undefined), fall
back to the previous promise in the chain. This prevents a TypeError
when chaining .then() on the reduce result.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham
Copy link
Contributor Author

@codex review

@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/CONST/index.ts 87.39% <ø> (ø)
src/libs/Request.ts 100.00% <100.00%> (ø)
src/libs/RequestThrottle.ts 94.11% <100.00%> (+0.78%) ⬆️
src/libs/actions/OnyxUpdates.ts 89.28% <100.00%> (+2.61%) ⬆️
src/libs/API/index.ts 86.53% <83.33%> (-2.13%) ⬇️
src/libs/actions/OnyxUpdateManager/index.ts 76.04% <69.23%> (-1.34%) ⬇️
src/libs/Network/SequentialQueue.ts 84.19% <70.27%> (-2.37%) ⬇️
... and 16 files with indirect coverage changes

@roryabraham roryabraham marked this pull request as ready for review February 19, 2026 18:43
@roryabraham roryabraham requested review from a team as code owners February 19, 2026 18:43
@melvin-bot melvin-bot bot requested review from heyjennahay and youssef-lr and removed request for a team February 19, 2026 18:43
@melvin-bot
Copy link

melvin-bot bot commented Feb 19, 2026

@youssef-lr 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]

@roryabraham
Copy link
Contributor Author

@heyjennahay no product considerations

@roryabraham roryabraham removed the request for review from heyjennahay February 19, 2026 18:46
@roryabraham roryabraham changed the title Add Sentry performance spans to the networking pipeline [No QA] Add Sentry performance spans to the networking pipeline Feb 19, 2026
roryabraham and others added 2 commits February 19, 2026 10:52
…rejection

Co-authored-by: Cursor <cursoragent@cursor.com>
…span

.finally() always set the span status to OK, masking errors. Now the
span correctly reports failure status when flushQueue() rejects.

Co-authored-by: Cursor <cursoragent@cursor.com>
Add MIDDLEWARE_* constants under CONST.TELEMETRY for all 10 production
middlewares and replace plain string names in API/index.ts and
MiddlewareTest.ts with the constants.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham roryabraham changed the title [No QA] Add Sentry performance spans to the networking pipeline [WIP][No QA] Add Sentry performance spans to the networking pipeline Feb 19, 2026
roryabraham and others added 2 commits February 19, 2026 14:58
- Convert makeXHR from .then() chain to flat async/await with try/catch
- Replace middlewares.reduce() with a for...of loop building a
  currentResponsePromise variable iteratively
- Replace final .then()/.catch() with try/catch around await
- Rename variables: pipeline -> currentResponsePromise,
  tappedLast -> instrumentedMiddlewareInput

Per-middleware .then() calls remain because the Middleware type contract
requires receiving a promise, not an awaited value. All span logic is
identical — no behavioral changes.

Co-authored-by: Cursor <cursoragent@cursor.com>
With the async/await conversion, TypeScript can no longer infer the
TKey generic parameter from the .then() chain's return type annotation.
Passing <TKey> explicitly to HttpUtils.xhr resolves the type mismatch.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham roryabraham changed the title [WIP][No QA] Add Sentry performance spans to the networking pipeline [No QA] Add Sentry performance spans to the networking pipeline Feb 19, 2026
@roryabraham
Copy link
Contributor Author

Updated and ready for review!

@JS00001
Copy link
Contributor

JS00001 commented Feb 20, 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 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 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.

@roryabraham roryabraham merged commit cb56ce7 into main Feb 20, 2026
33 of 35 checks passed
@roryabraham roryabraham deleted the rory-network-sentry-spans branch February 20, 2026 00:05
@github-actions
Copy link
Contributor

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

@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.3.24-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.3.24-3 🚀

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

roryabraham added a commit that referenced this pull request Mar 2, 2026
…spans"

This reverts commit cb56ce7, reversing
changes made to f8ce6e9.
roryabraham added a commit that referenced this pull request Mar 2, 2026
…spans"

This reverts commit cb56ce7, reversing changes made to
f8ce6e9.

Removes Sentry performance spans from the networking pipeline that were
causing 429 rate-limit errors and providing sub-millisecond measurements
that don't yield useful performance insights.

Made-with: Cursor
roryabraham added a commit that referenced this pull request Mar 2, 2026
…spans"

This reverts commit cb56ce7, reversing
changes made to f8ce6e9.
@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2026

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.3.31-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2026

🚀 Deployed to production by https://github.com/blimpich in version: 9.3.31-12 🚀

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.

4 participants