Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calculating the devicePixelRatio for the pdf to display with less pixels than the limit of the platform #25721

Merged
merged 22 commits into from
Aug 29, 2023

Conversation

ShogunFire
Copy link
Contributor

@ShogunFire ShogunFire commented Aug 22, 2023

Details

Each platform has a different max canvas size that can change without notice, we use canvas-size library to calculate that limit. Then we calculate the devicePixelRatio that allows the pdf to be displayed with less pixels than this limit

Fixed Issues

$ #23327
PROPOSAL: #23327 (comment)

Tests

  1. Go to any report
  2. Click on add attachment and select a pdf with big pages, for example this one
  3. Verify that the pdf is displayed correctly in the preview
  • Verify that no errors appear in the JS console

Offline tests

Same tests

QA Steps

Same 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web-pdf.mp4
Mobile Web - Chrome
mweb-pdf.mp4
Mobile Web - Safari
safari-pdf.mp4
Desktop
desktop-pdf.mp4
iOS
ios-pdf.mp4
Android
android-pdf.mp4

…els than the limit of the platform

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@ShogunFire ShogunFire requested a review from a team as a code owner August 22, 2023 21:09
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team August 22, 2023 21:09
@melvin-bot
Copy link

melvin-bot bot commented Aug 22, 2023

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

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@ShogunFire
Copy link
Contributor Author

ShogunFire commented Aug 22, 2023

Hello @eVoloshchak This works but I have some problems:

  • canvasSize.maxArea takes some time and it's slowing the render of the page, I think we should calculate it only once but I am not sure how to store it, is it a good use case for storing in onyx ?

  • Some PR checks are not successfull and I am not sure why

@ShogunFire

This comment was marked as resolved.

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
…pass the prop

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@ShogunFire
Copy link
Contributor Author

ShogunFire commented Aug 23, 2023

Weird behaviour on ios and android (see videos), I am checking tomorrow

@eVoloshchak
Copy link
Contributor

canvasSize.maxArea takes some time and it's slowing the render of the page, I think we should calculate it only once but I am not sure how to store it, is it a good use case for storing in onyx ?

Yes, we can absolutely store it on onyx. Also, have you tried if useWorker: true makes any difference in performance?

@eVoloshchak
Copy link
Contributor

Some PR checks are not successfull and I am not sure why

  • There are linter errors
  • I think Verify Podfile check is failing because when you add a new package, you also have to include package-lock.json and Podfile.lock to the PR

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

This comment was marked as resolved.

… state

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
Signed-off-by: Pierre Michel <pmiche04@gmail.com>
Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@ShogunFire
Copy link
Contributor Author

ShogunFire commented Aug 24, 2023

I still have to do this:

  • Add the canvas limits into onyx and retrieve them, should I store them as one object or 3 is fine ? I think 3 is easier because there are 3 callbacks onSuccess and I don't have to create a new type
  • Verify if the displaying on ios and android was like this before (not zoomed in)
  • Add comments and JSDocs
  • Fix lint errors after all is done

…ime we open a pdf

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
…Size

Signed-off-by: Pierre Michel <pmiche04@gmail.com>

# Conflicts:
#	src/ONYXKEYS.ts
@ShogunFire
Copy link
Contributor Author

So yes the zoom in problem is also on main

2023-08-25.10-49-30.mp4

@ShogunFire ShogunFire force-pushed the fixPdfBrokenMaxCanvasSize branch from 455650f to 5fedae8 Compare August 25, 2023 19:09
Signed-off-by: Pierre Michel <pmiche04@gmail.com>
Signed-off-by: Pierre Michel <pmiche04@gmail.com>
Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@ShogunFire
Copy link
Contributor Author

Ready for review

src/ONYXKEYS.ts Show resolved Hide resolved
src/libs/actions/CanvasSize.js Outdated Show resolved Hide resolved
src/libs/actions/CanvasSize.js Outdated Show resolved Hide resolved
src/libs/actions/CanvasSize.js Outdated Show resolved Hide resolved
src/components/PDFView/index.js Outdated Show resolved Hide resolved
…avoind calculating it every time we render, for example when we scroll

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
src/ONYXKEYS.ts Outdated Show resolved Hide resolved
src/ONYXKEYS.ts Outdated Show resolved Hide resolved
src/ONYXKEYS.ts Outdated Show resolved Hide resolved
ShogunFire and others added 4 commits August 28, 2023 10:36
Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>
Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>
Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>
Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@eVoloshchak
Copy link
Contributor

@ShogunFire, lint test is failing

@ShogunFire ShogunFire force-pushed the fixPdfBrokenMaxCanvasSize branch from 21ece13 to b80abb3 Compare August 28, 2023 17:08
@eVoloshchak
Copy link
Contributor

@ShogunFire, could you also verify if this works on native platforms?
I remember testing this and it definitely worked on iOS, but now it's failing for both Android and iOS

Screen.Recording.2023-08-28.at.20.04.06.mov
Screen.Recording.2023-08-28.at.20.06.40.mov

Signed-off-by: Pierre Michel <pmiche04@gmail.com>
@ShogunFire
Copy link
Contributor Author

@ShogunFire, could you also verify if this works on native platforms? I remember testing this and it definitely worked on iOS, but now it's failing for both Android and iOS

It is unrelated to this PR and also crash on main
image

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Aug 28, 2023

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
Screen.Recording.2023-08-28.at.21.06.31.mov
Mobile Web - Chrome
screen-20230828-210449.mp4
Mobile Web - Safari
Screen.Recording.2023-08-28.at.20.01.13.mov
Desktop
Screen.Recording.2023-08-28.at.21.05.09.mov
iOS
Screen.Recording.2023-08-28.at.21.13.37.mov
Android
Screen.Recording.2023-08-28.at.21.02.31.mov

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and tests well

@melvin-bot melvin-bot bot requested a review from pecanoro August 28, 2023 18:14
const ratioWidth = this.props.maxCanvasWidth / width;
const ratioArea = Math.sqrt(this.props.maxCanvasArea / nbPixels);
const ratio = Math.min(ratioHeight, ratioArea, ratioWidth);
return ratio > window.devicePixelRatio ? undefined : ratio;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would happen if we pass undefined to the page here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would happen if we pass undefined to the page here?

@pecanoro, the default devicePixelRatio would be used, same as before
By default, it matches screen device pixel ratio, so for example 3 on most iPhones, 1 on standard resolution office monitor
This does return undefined for most PDFs, only the ones that won't fit require a custom devicePixelRatio

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation, just making sure I understand the code properly 😄

@pecanoro pecanoro merged commit 766dd65 into Expensify:main Aug 29, 2023
@OSBotify
Copy link
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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.59-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.60-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.60-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

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

@OSBotify
Copy link
Contributor

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

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

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