fix: upgrade to newer react-pdf and pdf.js to render high-resolution images properly on the web

[artus9033]

Details

PDF files carrying images of large resolutions (such as the one posted in this issue) are not rendered on iOS Safari, although we would like them to be rendered properly.
This is because our app on the web uses react-pdf, which in turn uses pdf.js (here, from an NPM package pdfjs-dist) as renderer. The renderer utilizes a canvas to render PDF contents. Every browser has limitations applicable to the canvas element, since it requires a buffer to be allocated in memory. It is specified and well tested that Safari limits the maximum size to 4096x4096 px. The PDF provided in the original issue carries an image that breaks this limit.

The maintainers of pdf.js commented that starting from version 3.5.141 they are attempting to use the OffscreenCanvas to downsize over-large images in PDFs, if it is implemented in the host browser at runtime, which fixes the issue at the expense of rendering quality.

This PR concentrates on porting src/components/PDFView to work with react-pdf version 7.3.3 (which relies on pdfjs-dist version 3.6.172 that contains the aforementioned feature) that's aligned with the current work done in (WIP) switch to a custom library here.

Fixed Issues

$ #32502
PROPOSAL: #32502 (comment)

Tests

• Open a chat
• Send the PDF file attached in the original issue, containing a high resolution image
• Open the PDF
• Ensure that after a while (rendering) the image appears, in a slightly lower quality due to downscaling
• Ensure that other PDFs still work after changes, especially this large document from this issue that makes use of virtualized list rendering
• Ensure that PDFs secured with passwords are handled properly
• Ensure that there are no redundant re-renders of the PDF view (i.e., the PDF does not 'flash' when performing an interaction such as clicking / scrolling)

Offline tests

N/A since loading of chat attachments requires an internet connection.

QA Steps

• 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
  • MacOS: Desktop
• 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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.js 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 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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.
• 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-native.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

native-ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

safari-web.mov

chrome-web.mov

MacOS: Desktop

macos-desktop.mov

[melvin-bot]

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

[jjcoffee]

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 tests pass on all platforms & I tested again on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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.js 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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.
• 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: Native

android-native-2024-01-03_16.52.51.mp4

Android: mWeb Chrome

android-chrome-2024-01-03_13.54.30.mp4

iOS: Native

ios-native-2024-01-03_12.38.15.mp4

iOS: mWeb Safari

ios-safari-2024-01-03_12.25.06.mp4

MacOS: Chrome / Safari

desktop-chrome-2023-12-18_11.43.57.mp4

MacOS: Desktop

desktop-app-2023-12-18_12.05.20.mp4

[artus9033]

Thank you @jjcoffee, sorry for the trouble - I will track & fix the issues you mentioned.

[artus9033]

@jjcoffee the updated PR is ready for review now 🚀

[jjcoffee]

@artus9033 Thanks and sorry for the delay (I was OOO). Could you resolve conflicts?

[MrRefactor]

@jjcoffee I have just signed all the commits, the question is - where should I put updated videos? I also believe that checklist changed after Artur created this PR so how should we adjust that?

[jjcoffee]

Any way to stop the screen going white when resizing the window? I see it also happens on staging so we don't necessarily need to handle it here, but it would be nice if it's straight-forward enough:

chrome-resize-2024-01-17_14.29.55.mp4

[MrRefactor]

Any way to stop the screen going white when resizing the window? I see it also happens on staging so we don't necessarily need to handle it here, but it would be nice if it's straight-forward enough:

chrome-resize-2024-01-17_14.29.55.mp4

I dont think we are able to fix it right now - this behaviour is strictly connected to the flow of rendering pdf itself while resizing view -> resizing canvas size -> calculating density of pixels -> and then rerendering

[jjcoffee]

Tests well & LGTM!

[jjcoffee]

Checklist updated to the latest version.

[danieldoglas]

@jjcoffee shouldn't the new files be created in TS already?

[jjcoffee]

@danieldoglas Hmm good point! I think since the PR was raised before the announcement it might be best to avoid extra complexity by migrating the existing PR to TS as well. @MrRefactor just added a small tweak to @artus9033's original PR.

Once we switch to our custom PDF library, I'd expect all of that to be written in TS, maybe @rezkiy37 can confirm?

[rezkiy37]

I'd expect all of that to be written in TS, maybe @rezkiy37 can confirm?

The library is being written in TS. So, I already started to integrate react-fast-pdf into Expensify: #33434, Expensify/react-fast-pdf#12. Currently, I am waiting on this PR to be merged to continue working.

cc @jjcoffee

[jjcoffee]

@danieldoglas Sounds like we're good to merge this so that we unblock @rezkiy37's work on react-fast-pdf.

[danieldoglas]

@jjcoffee can you please use the most updated version of the checklist, since this is not passing the test for it?

Also, I'm trying to understand why this is not passing the snyk tests

[jjcoffee]

@danieldoglas Already updated, the check just needs to be rerun, I think!

[danieldoglas]

@rezkiy37 the snyk error is the following:

Out of sync package.json and package-lock.json detected. Please run "package.json install" and try again.

Can you please fix it and push it?

[rezkiy37]

@rezkiy37 the snyk error is the following:

Out of sync package.json and package-lock.json detected. Please run "package.json install" and try again.

Can you please fix it and push it?

Sorry, but current PR it is not mine.
cc @MrRefactor

[MrRefactor]

@rezkiy37 the snyk error is the following:

Out of sync package.json and package-lock.json detected. Please run "package.json install" and try again.

Can you please fix it and push it?

Hi @danieldoglas I have updated the branch, made sure of reinstalling all the depts and merging fresh main to it - as I can see there is still na issue with snyk

[jjcoffee]

@danieldoglas Apparently the snyk error happens on all PRs where the package file is changed, see here. So I think we're good to ignore for now!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.29-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅

[OSBotify]

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.29-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.29-1 🚀

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