Skip to content

Add new span for FAB add report to Scan Page#87765

Open
rinej wants to merge 4 commits intoExpensify:mainfrom
callstack-internal:sentry-add-camera-fab-sentry-spans
Open

Add new span for FAB add report to Scan Page#87765
rinej wants to merge 4 commits intoExpensify:mainfrom
callstack-internal:sentry-add-camera-fab-sentry-spans

Conversation

@rinej
Copy link
Copy Markdown
Contributor

@rinej rinej commented Apr 13, 2026

Explanation of Change

We need proper Sentry instrumentation for the Camera FAB → Scan page transition. Specifically, a parent span measuring the full time from FAB tap to camera ready, with two subspans:

  • Navigation to the Scan page
  • Scan page render until the camera is ready

In the PR I added a new dedicated Sentry span ManualEntryToScan with two subspans (ManualEntryToScanNavigation for FAB tap → Scan page mount, and ManualEntryToScanReady for Scan page mount → camera ready) to measure the Camera FAB → Scan page flow. The spans use a generic source attribute (camera_fab) so the same instrumentation can be reused for Global Create and Quick Action entry points without adding new constants. Both coexist with the existing ManualOpenCreateExpense span - no changes to current dashboards

Fixed Issues

$ #87854
PROPOSAL:

Tests

Web

  • Tap the Camera FAB button
  • Verify in Sentry (Explore) that a ManualEntryToScan span appears with:
  • source: camera_fab
  • platform: web
  • Confirm two child spans exist:
  • ManualEntryToScanNavigation
  • ManualEntryToScanReady

Native (iOS / Android)

  • Tap the Camera FAB button and wait for the camera to initialize
  • Verify in Sentry that a ManualEntryToScan span appears with:
  • source: camera_fab
  • platform: ios/android
  • Confirm:
  • ManualEntryToScanNavigation ends on page mount
  • ManualEntryToScanReady ends when the camera is ready

Non-FAB Entry

  • Open Create Expense via the Global Create menu
  • Verify that:
  • No ManualEntryToScan span is created
  • Only ManualOpenCreateExpense fires (unchanged behavior)

Offline tests

QA Steps

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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@rinej rinej changed the title Add ManualEntryToScan span in sentry Add new span for FAB add report to Scan Page Apr 13, 2026
@rinej rinej marked this pull request as ready for review April 14, 2026 10:56
@rinej rinej requested review from a team as code owners April 14, 2026 10:56
@melvin-bot melvin-bot Bot requested review from Ollyws and heyjennahay April 14, 2026 10:56
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 14, 2026

@Ollyws 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 requested review from a team, cretadn22 and cristipaval and removed request for a team April 14, 2026 10:56
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 14, 2026

@cretadn22 @cristipaval One of you needs to 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 April 14, 2026 10:56
Copy link
Copy Markdown

@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: 9932964686

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

Comment on lines +177 to +180
// Cancel entry-to-scan spans if they haven't ended naturally
cancelSpan(CONST.TELEMETRY.SPAN_ENTRY_TO_SCAN_NAVIGATION);
cancelSpan(CONST.TELEMETRY.SPAN_ENTRY_TO_SCAN_READY);
cancelSpan(CONST.TELEMETRY.SPAN_ENTRY_TO_SCAN);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Cancel entry-to-scan spans on permission denial

SPAN_ENTRY_TO_SCAN_READY and SPAN_ENTRY_TO_SCAN are only canceled in the unmount cleanup, so in the denied/blocked/unavailable permission path they stay active as long as the user remains on the Scan screen. That means a user who waits on the permission UI can produce inflated durations (or effectively never-finished spans), which skews the new FAB→Scan telemetry. The permission-status effect already cancels SPAN_OPEN_CREATE_EXPENSE; these new entry spans should be canceled there as well to keep measurements consistent.

Useful? React with 👍 / 👎.

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.

@rinej could you please address that?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

added the change and also resolved the conflicts

@cristipaval cristipaval removed the request for review from cretadn22 April 14, 2026 11:51
@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Apr 15, 2026

Does this require C+ review? If so is it possible for C+ to access the Sentry logs for this?

@rinej
Copy link
Copy Markdown
Contributor Author

rinej commented Apr 15, 2026

Does this require C+ review? If so is it possible for C+ to access the Sentry logs for this?

I'm not sure about it. I know that for the previous span additions @rlinoz was testing it, maybe you could help here as well?

@mkhutornyi
Copy link
Copy Markdown
Contributor

yes, C+ has access to sentry

@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Apr 15, 2026

@mkhutornyi We do, but do we have the permissions to create traces?

@mkhutornyi
Copy link
Copy Markdown
Contributor

@mkhutornyi We do, but do we have the permissions to create traces?

Not sure what you mean. We send data to Sentry through the app with sentry log enabled and then we should see logs in sentry dashboard.

@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Apr 15, 2026

I meant on dev, it wasn't sending the logs but let me see if I can get it going.

@mkhutornyi
Copy link
Copy Markdown
Contributor

I meant on dev, it wasn't sending the logs but let me see if I can get it going.

Try Troubleshoot > Switch Send data to Sentry on

@rlinoz
Copy link
Copy Markdown
Contributor

rlinoz commented Apr 15, 2026

Yep you can send spans from dev by doing the above.

@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Apr 15, 2026

Ah great, thanks!

@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Apr 15, 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 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Apr 15, 2026

@rinej Are we supposed to have a ManualEntryToScanReady child span on web?
I can only see it being added to index.native.tsx and I'm only getting ManualEntryToScanNavigation on web:

Screenshot 2026-04-15 at 20 20 55

@rinej
Copy link
Copy Markdown
Contributor Author

rinej commented Apr 23, 2026

Thanks for the input Olly!
The ManualEntryToScanReady span is intentionally native-only for now.
On native, camera initialization introduces quite big latency and, so it’s worth tracking as a dedicated child span.

On web, readiness is handled via the browser’s onUserMedia callback, which is generally faster and more predictable -so we just close the parent span on mount

We can add the extra logic to support a similar span on web as well.
Do we want to do it now, or wait until data shows it’s actually valuable?

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