Skip to content

Scan Receipt UX/perf improvements - #83470

Merged
marcaaron merged 16 commits into
mainfrom
marcaaron-scanReceiptImprovements
Mar 3, 2026
Merged

marcaaron merged 16 commits into
mainfrom
marcaaron-scanReceiptImprovements

Conversation

@marcaaron

@marcaaron marcaaron commented Feb 25, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Improves the receipt scan camera UX and reduces capture latency:

  1. Freeze camera on capture - Camera preview freezes immediately after photo is taken, providing clear visual feedback
  2. Enhanced shutter feedback - Pronounced flash effect (100% opacity, 50ms in + 150ms out) now triggers for all captures, not just multi-scan mode
  3. Pre-create upload directory - Directory creation moved from capture path to camera initialization, saving ~40ms per capture
  4. Eliminate image cropping from native capture path - Use useCameraFormat to select a 4:3 photo format and constrain the viewfinder to match that format's aspect ratio. Since the preview and photo now share the same aspect ratio, cropImageToAspectRatio is no longer needed on the native capture path, eliminating ~520ms of ImageSize.getSize() + expo-image-manipulator processing per capture. The crop codepath is unchanged for web and odometer image capture.

Note: The original SPAN_TAKE_PHOTO telemetry span from this PR was superseded by SPAN_RECEIPT_CAPTURE from #83729 during merge conflict resolution. Receipt capture telemetry is now covered by that span.

Fixed Issues

$ #83469

Tests

  1. Open the scan receipt screen
  2. Verify camera preview freezes immediately when you tap the shutter button
  3. Verify a dark flash effect appears when capturing (in both single and multi-scan modes)
  4. Verify photos are captured and saved correctly
  5. Verify that no errors appear in the JS console

Offline tests

N/A - camera capture is a local operation

QA Steps

  1. Open the scan receipt screen on a device
  2. Take several photos in single-scan mode and verify the camera freezes with a flash effect
  3. Enable multi-scan mode and take several photos, verify the same behavior
  4. Verify all captured receipts process correctly
  5. Verify that no errors appear in the JS console

Regression: Viewfinder matches saved photo (#66652)

  1. Tap FAB > Create expense > Scan tab
  2. Point camera at a document with clear edges
  3. Note the exact visible boundaries in the viewfinder
  4. Tap shutter
  5. Select a recipient
  6. Tap the receipt thumbnail to view full image
  7. Verify: saved image matches what the viewfinder showed — no extra content

Platforms: iOS, Android

Regression: Landscape capture (#71644)

  1. Tap + > Create expense > Scan tab
  2. Rotate phone to landscape
  3. Point at a document that fills the viewfinder
  4. Tap shutter
  5. Tap receipt picture to view full image
  6. Verify: image matches viewfinder, no content cut off, correct orientation
  7. Rotate to portrait, repeat steps 3-6
  8. Verify: portrait capture also correct

Platforms: iOS, Android

Regression: Multi-scan stability (#68516)

  1. Navigate to a workspace chat
  2. Start submit expense > Scan
  3. Enable multi-scan mode
  4. Take 20+ photos in rapid succession
  5. Tap submit
  6. Verify: all expenses created, SmartScan starts, no crash

Platforms: Android (primary), iOS

Regression: Odometer image capture

  1. Start a distance expense
  2. Navigate to odometer image capture
  3. Take a photo
  4. Verify: image is correctly captured and saved
  5. Repeat in landscape
  6. Verify: landscape capture also correct

Platforms: iOS, Android

Regression: Web scan unchanged

  1. Open web app in Chrome
  2. Create expense > Scan
  3. Capture a receipt photo
  4. Verify: saved image matches viewfinder
  5. Verify: no console errors

Platforms: Chrome, Safari

Regression: Gallery pick and receipt replacement

  1. Tap FAB > Create expense > Scan
  2. Tap gallery icon, select a photo
  3. Verify: image accepted and shown correctly
  4. Edit an existing expense with a receipt
  5. Replace receipt by taking a new photo
  6. Verify: replacement image correct

Platforms: iOS, Android

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

N/A changes affect mobile - issue does not exist on mWeb

iOS: Native
ScreenRecording_02-25-2026.10-22-36_1.MP4
iOS: mWeb Safari

N/A changes affect mobile - issue does not exist on mWeb

MacOS: Chrome / Safari

N/A changes affect mobile - issue does not exist on web

Freeze camera preview immediately after capture and add pronounced shutter flash effect for all captures (not just multi-scan mode) to provide clear visual feedback.
Move directory creation from capture critical path to camera initialization to reduce capture latency by ~40ms.
@marcaaron marcaaron self-assigned this Feb 25, 2026
@codecov

codecov Bot commented Feb 25, 2026 •

Copy link
Copy Markdown

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 Δ
.../request/step/IOURequestStepScan/useReceiptScan.ts 88.88% <ø> (ø)
src/styles/utils/index.ts 47.59% <0.00%> (-0.26%) ⬇️
...u/request/step/IOURequestStepScan/index.native.tsx 39.74% <12.50%> (+1.31%) ⬆️
... and 110 files with indirect coverage changes

Use useCameraFormat to select a known photo format, then pass it to the NavigationAwareCamera component so the camera captures at a predictable aspect ratio.
Compute aspect ratio from the selected format and apply it to the camera view so the preview matches the photo output exactly. Falls back to flex:1 if no format is available.
Since the viewfinder now matches the camera format aspect ratio, cropping is no longer needed. This eliminates ~520ms of image processing (reading dimensions + expo-image-manipulator) from the shutter-to-confirmation flow.
Remove cropImageToAspectRatio, ImageObject, LayoutRectangle imports and viewfinderLayout ref that are no longer needed since the native capture path no longer crops.
The format filter only matched aspect ratio, so it could pick a low-resolution 4:3 format causing a blurry preview. Add videoResolution and photoResolution 'max' filters to prefer the highest quality format.
Add getCameraViewfinderStyle() to StyleUtils for the dynamic viewfinder aspect ratio. Replace {backgroundColor: theme.appBG} with StyleUtils.getBackgroundColorStyle(). Both fix inline style violations per STYLING.md.
Restore 0.4 opacity / 10ms+50ms timing instead of the more pronounced 1.0 / 50ms+150ms version.
@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

This comment has been minimized.

@marcaaron
marcaaron marked this pull request as ready for review February 25, 2026 21:23
@marcaaron
marcaaron requested review from a team as code owners February 25, 2026 21:23
@melvin-bot
melvin-bot Bot requested review from a team, eVoloshchak and trjExpensify and removed request for a team February 25, 2026 21:23
@melvin-bot

melvin-bot Bot commented Feb 25, 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 requested review from huult and removed request for a team February 25, 2026 21:23
@melvin-bot

melvin-bot Bot commented Feb 25, 2026

Copy link
Copy Markdown

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


// Pre-create upload directory to avoid latency during capture
const path = getReceiptsUploadFolderPath();
ReactNativeBlobUtil.fs.isDir(path).then((isDir) => {

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.

❌ CONSISTENCY-6 (docs)

The ReactNativeBlobUtil.fs.isDir(path) promise is missing a .catch() handler. If the filesystem check fails, the error becomes an unhandled promise rejection and the upload directory will not be pre-created. The old code in capturePhoto had a .catch() for this same isDir call.

Add a .catch() to handle the isDir failure:

ReactNativeBlobUtil.fs.isDir(path).then((isDir) => {
    if (isDir) {
        return;
    }
    ReactNativeBlobUtil.fs.mkdir(path).catch((error: string) => {
        Log.warn('Error creating the receipts upload directory', error);
    });
}).catch((error: string) => {
    Log.warn('Error checking if the upload directory exists', error);
});

Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

@huult

huult commented Feb 28, 2026

Copy link
Copy Markdown
Contributor

@huult Interesting find. Not sure how often people would do this, but seems easy to fix.

I feel like it is logical to not allow this navigation to the manual tab if we have tapped the shutter button. Does everyone agree with that? IMO can be a follow up potentially.

@huult Would be great if you can a full review if you can. If you find another bug just keep going. This is a very urgent priority for us. Thanks.

@marcaaron Can you confirm that we will fix this issue in the next PR?

@huult

huult commented Feb 28, 2026

Copy link
Copy Markdown
Contributor
Screenshot 2026-02-28 at 09 26 02

Looks good, it's around 186 ms.

@huult huult 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 MarioExpensify February 28, 2026 02:28
@melvin-bot

melvin-bot Bot commented Feb 28, 2026

Copy link
Copy Markdown

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

@mountiny

mountiny commented Mar 1, 2026

Copy link
Copy Markdown
Contributor

@codex review

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

Copy link
Copy Markdown

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: 957a28564c

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

@marcaaron

Copy link
Copy Markdown
Contributor Author

@marcaaron Can you confirm that we will fix this issue in the next PR?

I think we do a follow up for this. It's an edge case.

@marcaaron

Copy link
Copy Markdown
Contributor Author

Created issue for us to look into later #83949

@marcaaron

Copy link
Copy Markdown
Contributor Author

@codex review

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

Copy link
Copy Markdown

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: 2c8824cf9d

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +405 to +407
if (isMultiScanEnabled) {
setDidCapturePhoto(false);
isCapturingPhoto.current = false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Keep freeze state active for multi-scan captures

didCapturePhoto is set to true when takePhoto() resolves, but in the multi-scan branch it is synchronously reset to false in the same callback. With React Native/React's automatic batching, the camera can skip rendering an intermediate true state, so forceInactive={... || didCapturePhoto} never takes effect and the preview does not visibly freeze for multi-scan shots. This regresses the intended UX feedback in the exact mode this change targets.

Useful? React with 👍 / 👎.

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.

The lack of a freeze in multi-scan is intentional as the camera should stay active between shots. This feedback is wrong to say there was a regression as we just implemented this. I tested to be sure and everything looks fine IMO.

@marcaaron marcaaron left a comment •

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.

Ok made requested changes. Re-testing...

@marcaaron

Copy link
Copy Markdown
Contributor Author

This is ready for internal review.

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

@marcaaron
marcaaron merged commit 245e40a into main Mar 3, 2026
35 checks passed
@marcaaron
marcaaron deleted the marcaaron-scanReceiptImprovements branch March 3, 2026 21:19
@github-actions

github-actions Bot commented Mar 3, 2026

Copy link
Copy Markdown
Contributor

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

puneetlath pushed a commit that referenced this pull request Mar 4, 2026
The callGetOptionData helper in SidebarUtilsTest.ts was missing the
required currentUserLogin property, causing the TypeScript check to fail.
This was a pre-existing issue on main introduced in the recent merge of
PR #83470.

Co-authored-by: Shridhar Goel <ShridharGoel@users.noreply.github.com>
@OSBotify

OSBotify commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

OSBotify commented Mar 6, 2026

Copy link
Copy Markdown
Contributor

🚀 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants