Skip to content

Fix react-native-pdf throws undefined is not a function - #106351

Merged
mountiny merged 4 commits into
Expensify:mainfrom
software-mansion-labs:fix/rn-pdf-crash
Nov 10, 2026
Merged

mountiny merged 4 commits into
Expensify:mainfrom
software-mansion-labs:fix/rn-pdf-crash

Conversation

@staszekscp

@staszekscp staszekscp commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Sentry APP-NAP is an unhandled TypeError: undefined is not a function from react-native-pdf 7.0.2. It happens when a native PDF's URL changes while the PDF is still downloading. In the events I checked, that's a cold start that restores the receipt screen, where the encryptedAuthToken in the receipt URL is refreshed during the first download.

_downloadFile stores the promise returned by .catch() in lastRNBFTask instead of the react-native-blob-util task, so it never has cancel(). When the URL changes, componentDidUpdate skips the cancel and starts a new download, which then calls lastRNBFTask.cancel() and throws. _prepareFile doesn't await _downloadFile, so the error becomes an unhandled promise rejection.

This PR adds react-native-pdf+7.0.2+007+fix-cancel-download-task.patch, which:

  • Stores the task itself, so the old download is really canceled, and checks that cancel() exists before calling it.
  • Gives each download an id. A canceled or replaced download ignores its result, so the cancellation isn't passed to onError (which PDFView would show as a load failure) and an old download can't replace the current PDF.
  • Loads the new source right away instead of in the cancel callback, which react-native-blob-util doesn't call once the request has finished.
  • Reports a failed download to onError once, instead of also copying it to the cache and showing it.

Bumping react-native-pdf isn't enough. 7.0.5 fixes the crash (wonday/react-native-pdf#1031) but still passes the cancellation to onError, so the receipt would show the load error. I opened wonday/react-native-pdf#1057 for that, and the patch can be dropped once it's released.

tests/unit/ReactNativePDFDownloadTest.tsx runs the real (patched) react-native-pdf JS with react-native-blob-util mocked. All 3 cases fail without the patch.

Fixed Issues

$ #106338
PROPOSAL:

Tests

  1. Go to Settings > Troubleshoot and, under Authentication status, press Invalidate with delay. The session expires 15 seconds later, which changes the auth token in the receipt URL.
  2. Within 15 seconds, open the expense and tap the PDF receipt to open it full screen.
  3. Keep it open until the session has expired, while the PDF is still downloading.
  4. Verify that no undefined is not a function or unhandled promise rejection error appears. On main it does. The receipt then shows only the file name: once the session expires, the receipt URL carries the invalidated token, the server rejects it, and the PDF fails to load. There's no crash. Close the receipt, reopen it a few seconds later once the app has re-authenticated, and verify the PDF loads.
  5. Open another PDF receipt and a PDF chat attachment normally, and verify they load.

Offline tests

QA Steps

Same as tests, iOS and Android only

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 verified any copy / text that was added to the app 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 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 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

Android: Native
android-106338-pr-test-steps-invalidate-with-delay.mp4
Android: mWeb Chrome
iOS: Native
ios-106338-pr-test-steps-invalidate-with-delay.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@staszekscp
staszekscp marked this pull request as ready for review November 9, 2026 12:16
@staszekscp
staszekscp requested a review from a team as a code owner November 9, 2026 12:16
@melvin-bot
melvin-bot Bot requested review from suneox and removed request for a team November 9, 2026 12:16
@melvin-bot

melvin-bot Bot commented Nov 9, 2026

Copy link
Copy Markdown

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

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

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

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-09T12:30:51.213133Z 4884177 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.

@staszekscp

Copy link
Copy Markdown
Contributor Author

Fixing oxlint and cspell...

@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: 48841776d1

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

@suneox

suneox commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

I'll take a look at this PR after an hour

@codecov

codecov Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 357 files with indirect coverage changes

@mountiny

mountiny commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

@suneox how is this looking?

+ // ignores its result, so there's no need to wait for the cancel callback, which react-native-blob-util
+ // doesn't call when the request has already finished.
+ this._cancelDownload();
+ this._loadFromSource(this.props.source);

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.

NAB: wonday/react-native-pdf#1057 also ignores a cache stat() in _loadFromSource that settles after the source changed (isCurrentSource), but this patch doesn't

@suneox

suneox commented Nov 10, 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 any copy / text that was added to the app 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 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 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

Android: HybridApp
az_recorder_20261110_095737.1.mp4

android-logcat.txt

Android: mWeb Chrome

Not available

iOS: HybridApp
CleanShot.2026-11-10.at.10.00.48.2.mp4

ios-log-full.txt

iOS: mWeb Safari

Not available

MacOS: Chrome / Safari
CleanShot.2026-11-10.at.10.05.54.3.mp4

@suneox

suneox commented Nov 10, 2026

Copy link
Copy Markdown
Contributor

@suneox how is this looking?

@mountiny Overall the PR looks good. The library error (undefined is not a function) is resolved. The only remaining comment is a NAB where the patch doesn't match the upstream library PR, which isn't a blocker.

@mountiny

Copy link
Copy Markdown
Contributor

Thank you. I will wait for Mariusz to address this.

@staszekscp

Copy link
Copy Markdown
Contributor Author

Addressed!

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

Lets give it a go

@mountiny
mountiny merged commit ad66280 into Expensify:main Nov 10, 2026
41 of 42 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

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

@github-actions

Copy link
Copy Markdown
Contributor

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.5.36-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.5.36-0 🚀

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.

4 participants