feat: update react-pdf to v6 #20817

allroundexperts · 2023-06-15T13:08:12Z

Details

This PR updates react-pdf package to v6 from v5. This was needed in order to fix the pdf text which was not getting un-selected by clicking anywhere inside the pdf.

Fixed Issues

$ #20098
PROPOSAL: #20098 (comment)

Tests

Open the Expensify App.
Navigate to a chat and send a PDF attachment.
Open the attachment.
Highlight text within the PDF
Now click on blank space in the PDF

Verify that the selected text gets unselected.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open the Expensify App.
Navigate to a chat and send a PDF attachment.
Open the attachment.
Highlight text within the PDF
Now click on blank space in the PDF

Verify that the selected text gets unselected.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-06-15.at.3.44.47.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-06-15.at.3.51.31.PM.mov

Mobile Web - Safari

Screen.Recording.2023-06-15.at.3.53.48.PM.mov

Desktop

Screen.Recording.2023-06-15.at.3.47.35.PM.mov

iOS

Screen.Recording.2023-06-15.at.3.53.48.PM.mov

Android

Screen.Recording.2023-06-15.at.3.55.17.PM.mov

melvin-bot · 2023-06-15T13:08:17Z

@tylerkaraszewski @parasharrajat One of you needs to 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]

parasharrajat · 2023-06-15T13:18:40Z

@allroundexperts Can you please add details on the breaking changed which affects our app?

allroundexperts · 2023-06-15T13:19:46Z

@allroundexperts Can you please add details on the breaking changed which affects our app?

Are you talking about this comment?

parasharrajat · 2023-06-15T13:19:39Z

src/components/PDFView/index.js

+import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
+import 'react-pdf/dist/esm/Page/TextLayer.css';


This is already being done from webpack config.

I think that's not correct. For v6 we need to explicitly add these.

parasharrajat · 2023-06-15T13:20:46Z

src/components/PDFView/index.js

Don't we have to change anything in the logic? Does everything work?

Yep. The only change needed is to import the css files.

parasharrajat · 2023-06-16T20:22:38Z

src/components/PDFView/index.js

+import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
+import 'react-pdf/dist/esm/Page/TextLayer.css';


Move TextLayer.css import to pdf.css.

Add a new entry in the webpack common config to copy Textlayer.css into the build folder.

parasharrajat · 2023-06-16T20:26:58Z

BUG; Safari iOS: app crashes when we scroll the PDF.

Test PDF:
Computer Programming for Beginners 3 Books in 1 By Kevin Cooper.pdf

allroundexperts · 2023-06-16T21:45:30Z

@parasharrajat The crash is due to this issue that we are tracking already. I think its not in the scope of this ticket as the app already crashes when uploading same file on Staging.

parasharrajat · 2023-06-19T14:06:52Z

I will retest the crash but can do the other changes.

allroundexperts · 2023-06-19T14:08:05Z

I will retest the crash but can do the other changes.

@parasharrajat I'm on these!

parasharrajat · 2023-06-19T16:08:30Z

Any update? Trying to get this merged asap.

allroundexperts · 2023-06-19T16:12:29Z

Any update? Trying to get this merged asap.

Copying file via webpack into the build folder does not seem to be getting loaded into the app. I'm checking the reason.

parasharrajat · 2023-06-19T16:14:03Z

You need to do both from #20817 (comment). CopyPlugin does not load the file only add the file in the build folder.

allroundexperts · 2023-06-19T16:15:21Z

You need to do both from #20817 (comment). CopyPlugin does not load the file only add the file in the build folder.

Do I load it inside the index.html file as a script?

allroundexperts · 2023-06-19T16:18:56Z

Also, @parasharrajat I'm curious on why we want to copy these over and not use directly. Would be great if you can share the reason.

parasharrajat · 2023-06-19T16:19:07Z

No, I mentioned that you need to load the CSS file in pdf.css file.

allroundexperts · 2023-06-19T16:20:35Z

No, I mentioned that you need to load the CSS file in pdf.css file.

Ah... I was confused because you mentioned pdf.js here 😅

allroundexperts · 2023-06-19T16:28:58Z

Made the requested changes.

parasharrajat · 2023-06-19T17:11:25Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-06-20.at.1.35.22.AM.mov

🔲 iOS / Safari

Screen.Recording.2023-06-20.at.1.32.49.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-06-20.at.1.33.48.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-06-19.at.10.47.54.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-06-20.at.1.34.31.AM.mov

🔲 Android / native

Screen.Recording.2023-06-20.at.1.56.16.AM.mov

parasharrajat · 2023-06-19T17:44:12Z

So the crash is a little bit different from that issue. On that issue, the app freezes but after upgrading the version in this PR, the app starts to crash. This PR increases the severity of that bug. Technically, it should be solved here for that reason alone but I understand there is already an issue with it so I will not prevent it from merging. Let's mention on that issue that after this PR the freeze will be converted to crash.

parasharrajat

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2023-06-19T20:07:33Z

cc: @tylerkaraszewski

OSBotify · 2023-06-21T21:00:18Z

✋ 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 · 2023-06-22T17:21:11Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.31-0 🚀

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

OSBotify · 2023-06-23T21:05:58Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.31-3 🚀

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

OSBotify · 2023-06-23T21:25:43Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.31-3 🚀

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

feat: update react-pdf to v6

9346adf

allroundexperts requested a review from a team as a code owner June 15, 2023 13:08

melvin-bot bot requested review from parasharrajat and tylerkaraszewski and removed request for a team June 15, 2023 13:08

allroundexperts mentioned this pull request Jun 15, 2023

[HOLD for payment 2023-06-30] [$1000] Text remains selected in a PDF attachment even after clicking on a blank space. #20098

Closed

6 tasks

parasharrajat suggested changes Jun 15, 2023

View reviewed changes

parasharrajat reviewed Jun 16, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

allroundexperts mentioned this pull request Jun 16, 2023

[HOLD for payment 2023-08-21] [HOLD for payment 2023-08-17] [$1000] mweb - Chat - Conversation freezes when sending a large PDF file #19918

Closed

6 tasks

mountiny assigned allroundexperts Jun 19, 2023

feat: load textlayer.css file into pdf.css

a70211c

allroundexperts requested a review from parasharrajat June 19, 2023 16:28

parasharrajat approved these changes Jun 19, 2023

View reviewed changes

puneetlath approved these changes Jun 21, 2023

View reviewed changes

puneetlath merged commit ff2502e into Expensify:main Jun 21, 2023

OSBotify mentioned this pull request Jun 22, 2023

Deploy Checklist: New Expensify 2023-06-22 #21330

Closed

39 tasks

lanitochka17 mentioned this pull request Jun 23, 2023

Android - Attachments - Unable to highlight text in PDF #21414

Closed

6 tasks

jjcoffee mentioned this pull request Jul 31, 2023

[HOLD for payment 2023-08-16] [$1000] Android emulator mWeb stuck at splash screen #22395

Closed

1 task

rayane-djouah mentioned this pull request May 9, 2024

[Snyk] Security upgrade react-pdf from 7.7.1 to 7.7.3 #41869

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update react-pdf to v6 #20817

feat: update react-pdf to v6 #20817

allroundexperts commented Jun 15, 2023

melvin-bot bot commented Jun 15, 2023

parasharrajat commented Jun 15, 2023

allroundexperts commented Jun 15, 2023

parasharrajat Jun 15, 2023

allroundexperts Jun 15, 2023

parasharrajat Jun 15, 2023

allroundexperts Jun 15, 2023

parasharrajat Jun 16, 2023 •

edited

Loading

parasharrajat commented Jun 16, 2023

This comment was marked as outdated.

allroundexperts commented Jun 16, 2023

parasharrajat commented Jun 19, 2023

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023 •

edited

Loading

allroundexperts commented Jun 19, 2023

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023

allroundexperts commented Jun 19, 2023 •

edited

Loading

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023 •

edited

Loading

parasharrajat commented Jun 19, 2023

parasharrajat left a comment

parasharrajat commented Jun 19, 2023

OSBotify commented Jun 21, 2023

OSBotify commented Jun 22, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 23, 2023

		import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
		import 'react-pdf/dist/esm/Page/TextLayer.css';

feat: update react-pdf to v6 #20817

feat: update react-pdf to v6 #20817

Conversation

allroundexperts commented Jun 15, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 15, 2023

parasharrajat commented Jun 15, 2023

allroundexperts commented Jun 15, 2023

parasharrajat Jun 15, 2023

Choose a reason for hiding this comment

allroundexperts Jun 15, 2023

Choose a reason for hiding this comment

parasharrajat Jun 15, 2023

Choose a reason for hiding this comment

allroundexperts Jun 15, 2023

Choose a reason for hiding this comment

parasharrajat Jun 16, 2023 • edited Loading

Choose a reason for hiding this comment

parasharrajat commented Jun 16, 2023

This comment was marked as outdated.

allroundexperts commented Jun 16, 2023

parasharrajat commented Jun 19, 2023

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023 • edited Loading

allroundexperts commented Jun 19, 2023

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023

allroundexperts commented Jun 19, 2023 • edited Loading

allroundexperts commented Jun 19, 2023

parasharrajat commented Jun 19, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat commented Jun 19, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

parasharrajat commented Jun 19, 2023

OSBotify commented Jun 21, 2023

OSBotify commented Jun 22, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 23, 2023

parasharrajat Jun 16, 2023 •

edited

Loading

parasharrajat commented Jun 19, 2023 •

edited

Loading

allroundexperts commented Jun 19, 2023 •

edited

Loading

parasharrajat commented Jun 19, 2023 •

edited

Loading