Skip to content

Cancel ManualSendMessage spans when report is loading#95559

Merged
cristipaval merged 4 commits into
Expensify:mainfrom
callstack-internal:sentry/cancel-send-message-span-on-skeleton
Jul 10, 2026
Merged

Cancel ManualSendMessage spans when report is loading#95559
cristipaval merged 4 commits into
Expensify:mainfrom
callstack-internal:sentry/cancel-send-message-span-on-skeleton

Conversation

@LukasMod

@LukasMod LukasMod commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

The ManualSendMessage span measures time from pressing Send until the sent message renders
(TextCommentFragment mounts). If a message is sent while the report-actions list is still showing a skeleton, the message can't render yet, so the span is blocked by other loading conditions.

Fix: while a report-actions skeleton is on screen, we now listen for ManualSendMessage spans started for
that report and cancel them immediately.

  • useCancelSendMessageSpanOnSkeleton — subscribes to Sentry's spanStart while mounted; cancels spans
    matching the report's report_id, tagging them with canceled_by_skeleton attribute.
  • ReportActionsLoadingSkeleton — thin wrapper rendered wherever a report-actions skeleton shows (in
    ReportActions and ReportActionsSkeletonGuard); hosts the hook and passes the skeletonName.
  • activeSpans.cancelSpanByInstance — cancels a span by its Sentry instance (the listener only has the raw
    span, not the id).
  • Composer is unchanged: it always starts the span, we don't block spans here based on skeleton conditions as these are not trivial and requires many onyx subscriptions or state lift up

Cancelled spans get: canceled: true, canceled_by_skeleton: <name> (report_actions_report_data_loading,
report_actions_app_load, skeleton_guard_loading, or skeleton_guard_derived_timing). Normal sends are
untouched and end with finished_manually: true.

Fixed Issues

$ #95583
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

The app logs each span to the console. In DevTools Console, filter by ManualSendMessage. Each span
prints a Starting span line and an Ending span line; expand the attributes object on the ending line
to read canceled, canceled_by_skeleton, report_id

Test 1 — sending while loading (span is cancelled)

  1. DevTools → Network → set throttling to Slow 3G or custom slower.
  2. App settings Troubleshoot → clear Onyx cache to force to allow reports to be fetched again when open
  3. Open a chat so the report shows a loading skeleton.
  4. Fast, While the skeleton is still visible, type a message and press Send (send 2–3 quickly).
  5. In the Console (filtered ManualSendMessage), verify each span's Ending span attributes have:
    • canceled: true
    • canceled_by_skeleton set to a skeleton name (e.g. skeleton_guard_loading for Concierge)
    • report_id = the open report's ID
  6. Duration is short (cancelled promptly), not seconds. No leaked/open ManualSendMessage span remains.

Test 2 — sending with no loading (works as before)

  1. Turn off network throttling; make sure the chat is fully loaded (no skeleton, messages visible).
  2. Type a message and press Send
  3. In the Console, verify the ManualSendMessage span's Ending span attributes have:
    • no canceled and no canceled_by_skeleton
    • report_id present
  4. Duration reflects the real send-to-render time

Test 3 — loaded Concierge + freshly opened chat, only the loading one is affected

  1. With normal network, open Concierge (right upper side icon that opens right panel on wide layout) and let it fully load (messages visible, no skeleton). Keep it open.
  2. Set Network throttling to Slow 3G
  3. Open a normal report/chat you haven't visited this session so it shows a loading skeleton
  4. In the still-loading chat, type a message and press Send → its ManualSendMessage span is canceled
    with canceled_by_skeleton and report_id = that chat.
  5. Switch to the already-loaded Concierge sand send a message → its span ends normally:
    no canceled / canceled_by_skeleton,

Offline tests

QA Steps

  • 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.mov
Android: mWeb Chrome
iOS: Native
ios.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mov

@codecov

codecov Bot commented Jul 8, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/CONST/index.ts 94.81% <ø> (+1.48%) ⬆️
src/hooks/useCancelSendMessageSpanOnSkeleton.ts 100.00% <100.00%> (ø)
src/libs/telemetry/activeSpans.ts 94.44% <100.00%> (+7.21%) ⬆️
src/pages/inbox/ReportActions.tsx 100.00% <100.00%> (ø)
...ages/inbox/report/ReportActionsLoadingSkeleton.tsx 100.00% <100.00%> (ø)
.../pages/inbox/report/ReportActionsSkeletonGuard.tsx 100.00% <100.00%> (ø)
... and 150 files with indirect coverage changes

@LukasMod

LukasMod commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: ebbc5bceed

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@LukasMod LukasMod marked this pull request as ready for review July 8, 2026 12:05
@LukasMod LukasMod requested review from a team as code owners July 8, 2026 12:05
@melvin-bot melvin-bot Bot requested review from eVoloshchak and heyjennahay and removed request for a team July 8, 2026 12:05
@melvin-bot

melvin-bot Bot commented Jul 8, 2026

Copy link
Copy Markdown

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

@melvin-bot melvin-bot Bot removed the request for review from a team July 8, 2026 12:05
@eVoloshchak

eVoloshchak commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

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 proper code patterns were followed (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 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)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately
    • 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
    • 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 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.
  • 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
Android: mWeb Chrome
iOS: HybridApp
Screen.Recording.2026-07-10.at.12.41.23.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2026-07-10.at.12.09.27.mov
Screen.Recording.2026-07-10.at.12.05.15.mov
Screen.Recording.2026-07-10.at.12.02.13.mov

@eVoloshchak eVoloshchak left a comment

Copy link
Copy Markdown
Contributor

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 cristipaval July 10, 2026 10:58
@cristipaval cristipaval merged commit 968b66d into Expensify:main Jul 10, 2026
39 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

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

@OSBotify

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

🚀 Deployed to staging by https://github.com/cristipaval in version: 9.4.33-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 Help site review: no changes required

I reviewed the changes in this PR against the help site articles under docs/articles. No help site updates are required, so I did not create a draft PR.

Why: This PR is purely internal Sentry telemetry/observability instrumentation. It cancels ManualSendMessage performance spans while a report-actions skeleton is on screen and adds the canceled_by_skeleton attribute. Specifically:

  • New useCancelSendMessageSpanOnSkeleton hook and cancelSpanByInstance helper — span lifecycle only.
  • New CONST.TELEMETRY.CANCELED_BY_SKELETON values and attribute constants.
  • Wiring in ReportActions / ReportActionsLoadingSkeleton / ReportActionsSkeletonGuard.
  • The only doc touched is contributingGuides/OBSERVABILITY_METRICS.md — a developer-facing internal reference, not a customer help article.

As the PR itself notes, the composer is unchanged and there is no change to any user-facing behavior, UI, feature name, tab, setting, or button. Help site articles document customer-facing product behavior, and nothing a user sees or does changes here.


@LukasMod, no help site PR was created since this is internal telemetry only. If you believe a customer-facing behavior did change and warrants a docs update, let me know and I'll draft one.

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.

5 participants