Skip to content

[Payment due @cretadn22] Fix silent receipt drop when file is missing from cache#86581

Merged
francoisl merged 17 commits into
mainfrom
neil-marcellini/fix-silent-receipt-drop
Apr 3, 2026
Merged

[Payment due @cretadn22] Fix silent receipt drop when file is missing from cache#86581
francoisl merged 17 commits into
mainfrom
neil-marcellini/fix-silent-receipt-drop

Conversation

@neil-marcellini

@neil-marcellini neil-marcellini commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

When a receipt image was written to an ephemeral iOS cache directory (e.g., Library/Caches/ImageManipulator/) by the crop/rotate functionality and the SequentialQueue was delayed (due to network issues, other pending requests, etc.), iOS could purge the cached file before the upload completed. The native prepareRequestPayload would silently omit the receipt from the FormData, creating an expense with no receipt attached and no error shown to the user.

This PR fixes the issue with two complementary approaches:

1. Safety net — alert on missing receipt files:
prepareRequestPayload/index.native.ts now logs an alert when checkFileExists returns false for a receipt, instead of silently dropping it. This ensures and engineer will investigate this case that should not occur.

2. Prevention — move crop/rotate output to durable storage:
A new moveReceiptToDurableStorage utility copies files from the ephemeral ImageManipulator cache to the durable Receipts-Upload directory. This is used in:

  • TransactionReceiptModalContent after crop/rotate operations
  • IOURequestStepOdometerImage native flow after cropImageToAspectRatio

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/615648

Tests

  1. Open the app on iOS
  2. Create an expense with a receipt photo
  3. Rotate or crop the receipt in the receipt viewer
  4. Verify the receipt uploads successfully
  5. Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

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

I'm unable to test on iOS currently, so asking if C+ can do it for me.

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Made with Cursor

When a receipt image was written to an ephemeral iOS cache directory
(e.g. Library/Caches/ImageManipulator/) and the SequentialQueue was
delayed, iOS could purge the file before upload. prepareRequestPayload
would silently omit the receipt from the FormData, creating an expense
with no receipt attached and no error shown to the user.

Changes:
- Throw an error in prepareRequestPayload when a receipt file is missing
  instead of silently dropping it, so the request fails visibly
- Add moveReceiptToDurableStorage utility that copies files from
  ephemeral cache to the durable Receipts-Upload directory
- Use durable storage after crop/rotate in TransactionReceiptModalContent
  and IOURequestStepOdometerImage native flows
- Add unit tests for prepareRequestPayload covering receipt file
  existence, missing files, and edge cases

Made-with: Cursor
@codecov

codecov Bot commented Mar 27, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/prepareRequestPayload/index.native.ts 67.64% <100.00%> (+67.64%) ⬆️
src/libs/moveReceiptToDurableStorage/index.ts 0.00% <0.00%> (ø)
.../step/IOURequestStepOdometerImage/index.native.tsx 0.00% <0.00%> (ø)
...c/libs/moveReceiptToDurableStorage/index.native.ts 70.58% <70.58%> (ø)
...alScreen/routes/TransactionReceiptModalContent.tsx 0.00% <0.00%> (ø)
... and 13 files with indirect coverage changes

Instead of throwing an error that could disrupt the SequentialQueue,
log an alert with the command name, source path, and filename so the
issue is surfaced without breaking the request flow.

Made-with: Cursor
Verifies that receipts produced by crop/rotate operations are moved
from the ephemeral ImageManipulator cache to the durable Receipts-Upload
directory. These tests fail on main (where cache URIs pass through
unchanged) and pass with the moveReceiptToDurableStorage fix.

Made-with: Cursor
Comments referencing "fix branch" vs "main" become misleading once
merged. Simplified to a direct requireActual import.

Made-with: Cursor
The empty-source scenario is not a realistic receipt flow and the test
was just verifying an implementation detail of the fallthrough logic.

Made-with: Cursor
- Fix trailing blank line in prepareRequestPayloadNativeTest.ts
- Replace deprecated StyleSheet.absoluteFillObject with absoluteFill

Made-with: Cursor
Comment on lines +366 to +368
style={[StyleSheet.absoluteFillObject, styles.backgroundWhite, blinkStyle, styles.zIndex10]}
style={[StyleSheet.absoluteFill, styles.backgroundWhite, blinkStyle, styles.zIndex10]}

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.

AI explains:

The ESLint rule @typescript-eslint/no-deprecated flagged StyleSheet.absoluteFillObject because React Native has deprecated it in favor of StyleSheet.absoluteFill.

They do the same thing -- both resolve to {position: 'absolute', left: 0, right: 0, top: 0, bottom: 0}. The only difference is that absoluteFill is typed as a registered style (number ID) which is slightly more optimized, while absoluteFillObject returns the plain object literal. React Native now recommends absoluteFill exclusively.

This was a pre-existing deprecation in IOURequestStepOdometerImage/index.native.tsx that CI flagged because our PR touched that file (adding the moveReceiptToDurableStorage import). The "changed files ESLint check" lints all files modified by the PR, so it caught this even though we didn't introduce it.

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

This comment has been minimized.

@neil-marcellini neil-marcellini marked this pull request as ready for review March 31, 2026 14:15
@neil-marcellini neil-marcellini requested review from a team as code owners March 31, 2026 14:15
@melvin-bot melvin-bot Bot requested review from cretadn22 and heyjennahay and removed request for a team March 31, 2026 14:15
@melvin-bot

melvin-bot Bot commented Mar 31, 2026

Copy link
Copy Markdown

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

@neil-marcellini

Copy link
Copy Markdown
Contributor Author

@cretadn22 would you please test on iOS for me? I'm currently unable to until our app deployer team re-generates some profiles.

Comment thread src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx Outdated
Comment thread tests/unit/libs/receiptDurableStorageTest.ts

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

ℹ️ 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 thread src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx Outdated
@cretadn22

Copy link
Copy Markdown
Contributor

@neil-marcellini yes

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
Built from App PR #86581.

Android 🤖 iOS 🍎
⏩ SKIPPED ⏩ ❌ FAILED ❌
The build for Android was skipped The QR code can't be generated, because the iOS build failed
Web 🕸️
⏩ SKIPPED ⏩
The build for Web was skipped

👀 View the workflow run that generated this build 👀

- Extract shared durable receipt logic into applyDurableReceipt helper
  to eliminate duplication between rotate and crop handlers (CONSISTENCY-3)
- Pass original file to replaceReceipt instead of spreading, which
  preserves the File prototype and Blob data on web (Codex P1)
- Add explanatory comment for eslint-disable in durable storage
  test (CONSISTENCY-5)

Made-with: Cursor
@cretadn22

cretadn22 commented Mar 31, 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 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
Screen.Recording.2026-04-02.at.23.57.23.mov
Android: mWeb Chrome
Screen.Recording.2026-04-03.at.00.04.12.mov
iOS: HybridApp
Screen.Recording.2026-04-02.at.23.51.39.mov
iOS: mWeb Safari
Screen.Recording.2026-04-03.at.00.02.47.mov
MacOS: Chrome / Safari
Screen.Recording.2026-04-03.at.00.00.07.mov

Avoids the abbreviated txnID variable and the no-shadow conflict with
the transactionID route param by reading transaction.transactionID
directly after the null guard.

Made-with: Cursor
Instead of checking existence before mkdir and separately after,
always call mkdir (which is a no-op if it already exists) then
verify it was created. Log an alert and bail if it still doesn't
exist after the mkdir attempt.

Made-with: Cursor
Two offline crop/rotate operations on different transactions could
both produce a file named receipt.jpg, causing one to overwrite the
other in Receipts-Upload. Generate a unique name using timestamp +
random suffix while preserving the file extension. Also update the
test mock from copyFile to moveFile and add a collision test.

Made-with: Cursor
Replace the ad-hoc Date.now + Math.random approach with the
codebase's existing rand64() utility from NumberUtils, which is
the standard client-side ID generator used for transaction IDs
and report IDs.

Made-with: Cursor
Insert the rand64 suffix before the file extension instead of
replacing the entire name, so receipt_4611686018427387903.jpg
preserves the original name for debugging context.

Made-with: Cursor
Resolve conflicts in TransactionReceiptModalContent.tsx: keep
applyDurableReceipt helper, update setMoneyRequestOdometerImage
to new signature (takes transaction object + isEditingConfirmation).

Made-with: Cursor
@neil-marcellini

Copy link
Copy Markdown
Contributor Author

Thanks for the review @cretadn22. It's updated and ready for another.

@cretadn22 cretadn22 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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot Bot requested a review from mollfpr April 2, 2026 17:10
@melvin-bot

melvin-bot Bot commented Apr 2, 2026

Copy link
Copy Markdown

@mollfpr 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 changed the title Fix silent receipt drop when file is missing from cache [Payment due @cretadn22] Fix silent receipt drop when file is missing from cache Apr 2, 2026
@melvin-bot

melvin-bot Bot commented Apr 2, 2026

Copy link
Copy Markdown

🎯 @cretadn22, thanks for reviewing and testing this PR! 🎉

A payment issue will be created for your review once this PR is deployed to production.
E/E issue linked to the PR - https://www.github.com/Expensify/Expensify/issues/615648.

If payment is not needed (e.g., regression PR review fix etc), react with 👎 to this comment to prevent the payment issue from being created.

@neil-marcellini

Copy link
Copy Markdown
Contributor Author

It's past working hours for @mollfpr so for the sake of urgency re-assigning internal review to @francoisl

@neil-marcellini neil-marcellini requested review from francoisl and removed request for mollfpr April 3, 2026 18:28
Comment thread src/libs/prepareRequestPayload/index.native.ts
@francoisl francoisl merged commit 3867667 into main Apr 3, 2026
40 checks passed
@francoisl francoisl deleted the neil-marcellini/fix-silent-receipt-drop branch April 3, 2026 18:36
@github-actions

github-actions Bot commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

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

@OSBotify

OSBotify commented Apr 3, 2026

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

OSBotify commented Apr 7, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.3.53-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site changes are required for this PR.

The changes are purely an internal bug fix for iOS file storage handling — moving receipt files from ephemeral cache directories to durable storage and adding alerting when files are missing. There are no changes to user-facing features, UI labels, settings, workflows, or button names.

The existing help article Attach-and-edit-receipts-on-expenses.md already accurately describes how to crop/rotate receipts, and this PR doesn't change that behavior from the user's perspective — it just ensures the underlying files persist reliably on iOS.

@OSBotify

OSBotify commented Apr 7, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.3.53-0 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

OSBotify commented Apr 7, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.53-7 🚀

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.

5 participants