Fix freezes when previewing a large PDF file #22760

rezkiy37 · 2023-07-12T17:48:15Z

Details

Improved pdf files previewing for the Web and Desktop applications. It allows to render properly any size of pdf files. The next changes do not affect on IOS or Android.

Fixed Issues

$ #19918
PROPOSAL: #19918 (comment)

Tests

Have own or download this large.pdf.
Open any chat.
Click on "+" (actions) to the left of Composer.
Click on "Add attachment".
Select the pdf file.
Verify that "Send attachment" modal previews the file correctly.
Click on "Send".
Click on the attachment you just sent.
Verify that "Attachment" modal previews the file correctly.

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

MacOS.Safari.mp4

MacOS.Chrome.mp4

Mobile Web - Chrome

Android.Chrome.mp4

IOS.Chrome.mp4

Mobile Web - Safari

IOS.Safari.mp4

Desktop

Desktop.mp4

iOS

IOS.mp4

Android

Android.mp4

…/19918-preview-large-pdf

src/components/PDFView/index.js

thiagobrez · 2023-07-13T08:18:02Z

Tested locally and works well!

melvin-bot · 2023-07-13T11:20:12Z

@0xmiroslav 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]

…/19918-preview-large-pdf

rezkiy37 · 2023-07-19T11:59:11Z

@0xmiroslav, just a friendly reminder to review the PR 🙂

0xmiros · 2023-07-19T12:03:54Z

reviewing today

rezkiy37 · 2023-07-24T09:03:37Z

@0xmiroslav any feedback?

0xmiros · 2023-07-25T04:24:06Z

Tests step is missing

0xmiros

Scroll position is not correct

Screen.Recording.2023-07-25.at.6.28.32.AM.mov

rezkiy37 · 2023-07-25T09:36:11Z

Scroll position is not correct

Screen.Recording.2023-07-25.at.6.28.32.AM.mov

@0xmiroslav, just to clarify: do you mean the scroll bar position itself or cursor inside?

0xmiros · 2023-07-25T09:37:56Z

@rezkiy37 my video shows diff between this branch and staging

0xmiros · 2023-07-25T09:39:47Z

Ideally, our fix shouldn't affect design (scrollbar position, pdf container position, etc)

rezkiy37 · 2023-07-25T11:32:42Z

Ideally, our fix shouldn't affect design (scrollbar position, pdf container position, etc)

Definitely, let me try to fix it.

…/19918-preview-large-pdf

situchan · 2023-08-04T06:31:00Z

There's minor difference but I think this is not blocker

Screen.Recording.2023-08-04.at.12.30.00.PM.mov

situchan · 2023-08-04T06:32:13Z

Page refreshes when switch to another tab and come back. This doesn't happen on staging. I think this can be bug and should be fixed here.

Screen.Recording.2023-08-04.at.12.28.47.PM.mov

rezkiy37 · 2023-08-04T08:50:31Z

@rezkiy37 can you please add Tests step with sample large PDF?

Sure, my bad. I will add it asap.

rezkiy37 · 2023-08-04T09:10:56Z

There's minor difference but I think this is not blocker

Screen.Recording.2023-08-04.at.12.30.00.PM.mov

Such kind of small diffs could be. The current PDF previewer does not take into accounts page borders. So, this PR calculates everything properly.
FYI: #22760 (comment)

rezkiy37 · 2023-08-04T09:32:55Z

@rezkiy37 can you please add Tests step with sample large PDF?

Sure, my bad. I will add it asap.

Done!

…/19918-preview-large-pdf

rezkiy37 · 2023-08-04T13:43:16Z

Page refreshes when switch to another tab and come back. This doesn't happen on staging. I think this can be bug and should be fixed here.

Screen.Recording.2023-08-04.at.12.28.47.PM.mov

@situchan, I've tried to reproduce it. Yes, it is reproducible, but not always. Moreover, it happens on the staging as well (an example starts from the 32nd second of the video). Also, this re-fresh happens on other websites where no pdf at all. I would say that IOS Safari tries to save memory this way and "unmounts" websites.

IOS.Safari.shifts.mp4

situchan · 2023-08-07T10:02:11Z

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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

situchan

Looks good, tests well.
Just minor feedback

src/components/PDFView/index.js

situchan · 2023-08-07T10:11:57Z

Also, the branch conflicts

…/19918-preview-large-pdf

situchan

rezkiy37 · 2023-08-08T17:17:07Z

@situchan, just to clarify: who is going to merge this PR? Since, it is approved, we can move forward.

situchan · 2023-08-08T17:19:42Z

@situchan, just to clarify: who is going to merge this PR? Since, it is approved, we can move forward.

@puneetlath will do final review & merge

melvin-bot · 2023-08-08T21:06:18Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2023-08-08T21:14:52Z

✋ 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-08-09T09:11:05Z

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

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

OSBotify · 2023-08-09T09:49:48Z

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

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

OSBotify · 2023-08-10T20:08:14Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

rezkiy37 added 7 commits June 21, 2023 13:16

Add react-window

1996119

Fix previewing of large pdf files

e0d3535

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

1257ab3

…/19918-preview-large-pdf

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

2c90716

…/19918-preview-large-pdf

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

8be7ec1

…/19918-preview-large-pdf

fix dimensions

ae1ab8a

add JSDoc

d8b5873

thiagobrez reviewed Jul 13, 2023

View reviewed changes

src/components/PDFView/index.js Outdated Show resolved Hide resolved

thiagobrez reviewed Jul 13, 2023

View reviewed changes

src/components/PDFView/index.js Outdated Show resolved Hide resolved

thiagobrez reviewed Jul 13, 2023

View reviewed changes

src/components/PDFView/index.js Show resolved Hide resolved

rezkiy37 added 2 commits July 13, 2023 11:20

improve PDFView methods

c95c775

use currying

7c190a5

rezkiy37 marked this pull request as ready for review July 13, 2023 11:20

rezkiy37 requested a review from a team as a code owner July 13, 2023 11:20

melvin-bot bot requested review from 0xmiros and removed request for a team July 13, 2023 11:20

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

d1939a9

…/19918-preview-large-pdf

rezkiy37 mentioned this pull request Jul 17, 2023

[HOLD for payment 2024-04-05] Convert internal PDF preview into a public library #22998

Closed

6 tasks

0xmiros reviewed Jul 25, 2023

View reviewed changes

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

b1fcbb8

…/19918-preview-large-pdf

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

b35b11b

…/19918-preview-large-pdf

situchan reviewed Aug 7, 2023

View reviewed changes

src/components/PDFView/index.js Show resolved Hide resolved

rezkiy37 added 3 commits August 7, 2023 12:54

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

1cbbe74

…/19918-preview-large-pdf

simplify onDocumentLoadSuccess

a151a1c

fix

717f296

situchan approved these changes Aug 7, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath August 7, 2023 11:37

rezkiy37 mentioned this pull request Aug 7, 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

puneetlath approved these changes Aug 8, 2023

View reviewed changes

puneetlath merged commit c70a619 into Expensify:main Aug 8, 2023

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

This was referenced Aug 9, 2023

Fix PDF blinks #24308

Merged

Attachments - User can not scroll the PDF by using the down/up arrow in Keyboard #24326

Closed

User can scroll PDF by using the down/up arrow of keyboard #24363

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix freezes when previewing a large PDF file #22760

Fix freezes when previewing a large PDF file #22760

rezkiy37 commented Jul 12, 2023 •

edited

Loading

thiagobrez commented Jul 13, 2023

melvin-bot bot commented Jul 13, 2023

rezkiy37 commented Jul 19, 2023

0xmiros commented Jul 19, 2023

rezkiy37 commented Jul 24, 2023

0xmiros commented Jul 25, 2023

0xmiros left a comment

rezkiy37 commented Jul 25, 2023

0xmiros commented Jul 25, 2023

0xmiros commented Jul 25, 2023

rezkiy37 commented Jul 25, 2023

situchan commented Aug 4, 2023

situchan commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

situchan commented Aug 7, 2023

situchan left a comment

situchan commented Aug 7, 2023

situchan left a comment

rezkiy37 commented Aug 8, 2023

situchan commented Aug 8, 2023

melvin-bot bot commented Aug 8, 2023

OSBotify commented Aug 8, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

Fix freezes when previewing a large PDF file #22760

Fix freezes when previewing a large PDF file #22760

Conversation

rezkiy37 commented Jul 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

thiagobrez commented Jul 13, 2023

melvin-bot bot commented Jul 13, 2023

rezkiy37 commented Jul 19, 2023

0xmiros commented Jul 19, 2023

rezkiy37 commented Jul 24, 2023

0xmiros commented Jul 25, 2023

0xmiros left a comment

Choose a reason for hiding this comment

rezkiy37 commented Jul 25, 2023

0xmiros commented Jul 25, 2023

0xmiros commented Jul 25, 2023

rezkiy37 commented Jul 25, 2023

situchan commented Aug 4, 2023

situchan commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

rezkiy37 commented Aug 4, 2023

situchan commented Aug 7, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

situchan commented Aug 7, 2023

situchan left a comment

Choose a reason for hiding this comment

rezkiy37 commented Aug 8, 2023

situchan commented Aug 8, 2023

melvin-bot bot commented Aug 8, 2023

OSBotify commented Aug 8, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

rezkiy37 commented Jul 12, 2023 •

edited

Loading