Skip to content

Comments

[WIP][No QA] Add per-migration Sentry spans to Onyx migration runner#83263

Draft
roryabraham wants to merge 1 commit intomainfrom
rory-sentry-onyx-migrations
Draft

[WIP][No QA] Add per-migration Sentry spans to Onyx migration runner#83263
roryabraham wants to merge 1 commit intomainfrom
rory-sentry-onyx-migrations

Conversation

@roryabraham
Copy link
Contributor

@roryabraham roryabraham commented Feb 23, 2026

Explanation of Change

The Onyx migration runner already creates a single Sentry span wrapping all migrations, but we have no visibility into how long each individual migration takes. This PR instruments the migration runner so that each migration gets its own child Sentry span nested under the existing ONYX_MIGRATIONS parent span.

Changes are confined to migrateOnyx.ts:

  • Added Sentry.startInactiveSpan() around each migration invocation
  • Changed the migrations array to named objects so each span has a descriptive label
  • Each span is a child of the ONYX_MIGRATIONS bootsplash span

Fixed Issues

N/A - internal improvement for Sentry performance visibility

Tests

  • Verify that no errors appear in the JS console
  • Verify that Sentry traces show individual migration spans nested under the BootsplashVisibleOnyxMigrations span

Offline tests

N/A - Sentry telemetry is best-effort and does not affect offline behavior.

QA Steps

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

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 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

N/A - no UI changes

Android: mWeb Chrome

N/A - no UI changes

iOS: Native

N/A - no UI changes

iOS: mWeb Safari

N/A - no UI changes

MacOS: Chrome / Safari

N/A - no UI changes

Made with Cursor

@roryabraham @cursoragent
Add per-migration Sentry spans to Onyx migration runner
53b281f 
Each individual migration now gets its own Sentry span nested
under the existing ONYX_MIGRATIONS parent span, giving us
per-migration visibility in Sentry performance traces.

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

roryabraham commented Feb 23, 2026

@codex review

chatgpt-codex-connector[bot]
chatgpt-codex-connector bot reviewed Feb 23, 2026
View reviewed changes
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 53b281f05e

ℹ️ 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".

src/libs/migrateOnyx.ts
parentSpan: getSpan(CONST.TELEMETRY.SPAN_BOOTSPLASH.ONYX_MIGRATIONS),
});
return migration().finally(() => {
span?.setStatus({code: 1});
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Feb 23, 2026

Choose a reason for hiding this comment

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

P2 Badge Mark failed migration spans as errors

Because span.setStatus({code: 1}) is executed inside .finally(), a migration that rejects is still recorded as a successful span. In the failure scenario, this makes Sentry trace data incorrect and hides which migration actually failed, which undermines the purpose of adding per-migration instrumentation.

Useful? React with 👍 / 👎.

@roryabraham roryabraham changed the title [No QA] Add per-migration Sentry spans to Onyx migration runner [WIP][No QA] Add per-migration Sentry spans to Onyx migration runner Feb 23, 2026
@codecov
Copy link

codecov bot commented Feb 24, 2026 •
edited by github-actions bot
Loading

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/migrateOnyx.ts 100.00% <100.00%> (ø)
... and 10 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chatgpt-codex-connector chatgpt-codex-connector[bot] chatgpt-codex-connector[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@roryabraham roryabraham

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@roryabraham