Skip to content

Remove unsafe type assertions from native receipt validation - #100214

Merged
blimpich merged 3 commits into
Expensify:mainfrom
KJ21-ENG:seatbelt/c12-260901-r12
Oct 19, 2026
Merged

blimpich merged 3 commits into
Expensify:mainfrom
KJ21-ENG:seatbelt/c12-260901-r12

Conversation

@KJ21-ENG

@KJ21-ENG KJ21-ENG commented Sep 2, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Removes two unsafe type assertions from native receipt validation by using the app’s receipt-file type. Receipt handling remains unchanged.

Changed files (2)
  • src/libs/fileDownload/validateReceiptFile/index.native.ts
  • src/pages/iou/request/step/confirmation/ReceiptFileValidator.tsx

Fixed Issues

$ #94739
PROPOSAL: #94739 (comment)

Tests

For this PR head, upstream TypeScript, ESLint, formatting and eight Jest test jobs passed.

QA Steps

No additional change-specific manual QA is required for this type/comment-only change.

  • Optional receipt smoke: attach an image to an expense, confirm the preview, create the expense and open its stored receipt. Expected: the image remains readable.

PR Author Checklist

Unchecked testing items remain pending or lack exact-head evidence in the retained record. The type-only change adds no UI, CSS, copy, assets or focused unit test; these conditional rows do not claim execution.

  • 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 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 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)
  • 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 the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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

MacOS: Chrome / Safari
100214-desktop-corrected.mp4

@codecov

codecov Bot commented Sep 2, 2026 •

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/fileDownload/validateReceiptFile/index.ts 0.00% <ø> (ø)
...request/step/confirmation/ReceiptFileValidator.tsx 80.48% <100.00%> (ø)
...s/fileDownload/validateReceiptFile/index.native.ts 80.00% <50.00%> (ø)
... and 145 files with indirect coverage changes

@KJ21-ENG
KJ21-ENG marked this pull request as ready for review October 1, 2026 19:56
@KJ21-ENG
KJ21-ENG requested review from a team as code owners October 1, 2026 19:56
@melvin-bot
melvin-bot Bot requested review from ikevin127 and joekaufmanexpensify and removed request for a team October 1, 2026 19:56
@melvin-bot

melvin-bot Bot commented Oct 1, 2026

Copy link
Copy Markdown

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

@KJ21-ENG
KJ21-ENG marked this pull request as draft October 1, 2026 21:05
@ikevin127

ikevin127 commented Oct 1, 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.
  • If the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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

Screen.Recording.iPhone.17.Pro.Max.10-01-2026.at.17.17.33.mp4


import type {ReceiptSource} from '@src/types/onyx/Transaction';
import type {FileObject} from '@src/types/utils/Attachment';

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.

🟡 The platform pair now has divergent onSuccess signatures, and TypeScript only ever checks the web one.

index.ts        (web)    onSuccess: (file: File) => void        returns Promise<void | File> | undefined
index.native.ts (native) onSuccess: (file: FileObject) => void  returns Promise<void>

There is no moduleSuffixes in tsconfig.json or the inherited expo/tsconfig.base, so @libs/fileDownload/validateReceiptFile resolves to index.ts for every caller. The native signature change is invisible to the type system at every call site.

Today there is exactly one caller (ReceiptFileValidator.tsx:118) and it happens to pass the wider callback, so this is safe right now. The failure mode is the next caller:

// typechecks clean against index.ts, crashes on Android and iOS
validateReceiptFile(name, path, type, (file: File) => uploadBlob(file.slice()), onFailure);

index.native.ts hands that callback {uri, name, type, source}, which has no slice. TypeScript signs off because it read the web file.

Make both sides agree:

// index.ts
onSuccess: (file: FileObject) => void,

checkIfLocalFileIsAccessible (src/libs/actions/IOU/Receipt.ts:381) declares (file: File) => void, and the augmented File is assignable to FileObject, so passing the widened callback through should still typecheck. Worth running npm run typecheck to confirm rather than taking my word for it.

The return types also diverge (Promise<void | File> | undefined vs Promise<void>), but that predates this PR and the caller already handles it with ?? Promise.resolve(). Not worth touching here.

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.

Thanks for catching this. I changed the validateReceiptFile callback type to FileObject on both web and native, so callers are checked against the type native actually provides. The updated PR passed the TypeScript check.

@@ -2,6 +2,7 @@ import checkFileExists from '@libs/fileDownload/checkFileExists';
import ReceiptStorage from '@libs/ReceiptStorage';

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.

🟡 The branch is 10152 commits behind main.

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.

I merged main into the PR branch and resolved the conflict in the native receipt validator. The resolution keeps the newer receipt recheck behavior from main alongside the FileObject type fix. GitHub now reports the PR as mergeable.

Comment on lines 93 to 94
// Rebuilding the receipt from disk makes a fresh File without the trace id from capture, so copy it
// back from the saved draft. This keeps the capture, submit, and enqueue logs tied to one receipt.

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.

🟢 src/pages/iou/request/step/confirmation/ReceiptFileValidator.tsx:93-94 - the comment now says File where native produces a FileObject.

// Rebuilding the receipt from disk makes a fresh File without the trace id from capture, so copy it

Accurate on web, no longer accurate on native, and this PR is specifically about making that distinction explicit. "a fresh file object" reads correctly on both platforms.

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.

Fixed the comment in ReceiptFileValidator to say “file object,” which accurately describes the value on both web and native.

@KJ21-ENG
KJ21-ENG marked this pull request as ready for review October 16, 2026 21:21
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-16T21:50:15.813368Z a73784d Draft marked ready
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@ikevin127 ikevin127 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 - All previous comments were addressed

@blimpich
blimpich merged commit 30c33c7 into Expensify:main Oct 19, 2026
44 of 53 checks passed
@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.

@github-actions

Copy link
Copy Markdown
Contributor

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/blimpich in version: 9.5.15-1 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site update is needed. This PR only changes TypeScript types and a code comment in receipt validation, so receipt handling looks and works the same for users.


view run

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.5.15-3 🚀

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

Bundle Size Analysis (Sentry):

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