refactor: migrate PDFView/index.js to function component #36809

s-alves10 · 2024-02-19T17:09:22Z

Details

Migrate PDFView/index.js to function component

Fixed Issues

$ #16186
PROPOSAL: #16186 (comment)

Tests

Open ND and log in with any account
Navigate to any chat
[WEB AND MOBILE WEB] Tap "+" button near the main composer and select "Add attachment"
[WEB AND MOBILE WEB] Attach normal pdf document and verify that the pdf is displayed properly in preview
[WEB AND MOBILE WEB] Send the pdf
[WEB AND MOBILE WEB] Attach protected pdf document and verify that the pdf is displayed properly in preview
[WEB AND MOBILE WEB] Send the pdf
[WEB AND MOBILE WEB] Tap pdf documents in the chat and they are displayed properly

Verify that no errors appear in the JS console

Offline tests

Open ND and log in with any account
Navigate to any chat
[WEB AND MOBILE WEB] Tap "+" button near the main composer and select "Add attachment"
[WEB AND MOBILE WEB] Attach normal pdf document and verify that the pdf is displayed properly in preview
[WEB AND MOBILE WEB] Send the pdf
[WEB AND MOBILE WEB] Attach protected pdf document and verify that the pdf is displayed properly in preview
[WEB AND MOBILE WEB] Send the pdf
[WEB AND MOBILE WEB] Tap pdf documents in the chat and they are displayed properly

QA Steps

Open ND and log in with any account
Navigate to any chat
[WEB AND MOBILE WEB] Tap "+" button near the main composer and select "Add attachment"
[WEB AND MOBILE WEB] Attach normal pdf document and verify that the pdf is displayed properly in preview
[WEB AND MOBILE WEB] Send the pdf
[WEB AND MOBILE WEB] Attach protected pdf document and verify that the pdf is displayed properly in preview
[WEB AND MOBILE WEB] Send the pdf
[WEB AND MOBILE WEB] Tap pdf documents in the chat and they are displayed properly

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

16186_android_native.mp4

Android: mWeb Chrome

16186_android_chrome.mp4

iOS: Native

16186_ios_native.mp4

iOS: mWeb Safari

16186_ios_safari.mp4

MacOS: Chrome / Safari

16186_mac_chrome.mp4

MacOS: Desktop

16186_mac_desktop.mp4

melvin-bot · 2024-02-20T07:03:03Z

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

s-alves10 · 2024-02-21T06:35:46Z

@ishpaul777

friendly bump

ishpaul777 · 2024-02-21T12:52:33Z

reviewing today 👀

ishpaul777 · 2024-02-21T12:52:59Z

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

not applicable

Android: mWeb Chrome

Screen.Recording.2024-03-03.at.6.10.41.AM.mov

iOS: Native

not applicable

iOS: mWeb Safari

Screen.Recording.2024-03-03.at.6.04.47.AM.mov

MacOS: Chrome / Safari

Untitled-1.mov

MacOS: Desktop

Screen.Recording.2024-03-03.at.6.17.46.AM.mov

ishpaul777 · 2024-02-21T14:08:40Z

src/components/PDFView/index.js

+    const [isKeyboardOpen, setIsKeyboardOpen] = useState(false);
+    const prevWindowHeight = usePrevious(windowHeight);
+
+    useEffect(() => {


do we even need this in a useEffect if this runs only on first render?

ishpaul777 · 2024-02-21T14:09:20Z

src/components/PDFView/index.js

        }
-    }
+        // eslint-disable-next-line react-hooks/exhaustive-deps


why this rule disabled ?

This effect has an additional dependency: toggleKeyboardOnSmallScreens. This method depends on isSmallScreenWidth and onToggleKeyboard. We need to prevent this effect from running when they are changed. That's the reason

lets add a comment for explaination 👍

ishpaul777 · 2024-02-21T14:34:08Z

src/components/PDFView/index.js

+            return actualHeight;
+        },
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+        [numPages, calculatePageWidth],


why do we need numPages as dependency?

Actually we should have pageViewports as its dependency.
But pageViewports is an object(array) and changed every time the document is loaded. Having it as a state and specifying as the dependency of this method would re-render the component every time the document is loaded and would cause the component infinite re-render. And having this as a ref wouldn't change the calculatePageWidth method after the document is loaded.

As you can see, pageViewports and numPages are set when the document is loaded, but numPages is a scalar value and not changed as long as the document is not changed. So specifying this as a dependency instead of pageViewports would prevent the infinite re-render. And when the document is changed, it would change as well

This is the reason I added numPages as a dependency instead of pageViewports

lets add a comment here also

ishpaul777 · 2024-02-21T14:36:48Z

Overall looks great, some minor comments for clarifications @s-alves10

ishpaul777 · 2024-02-22T17:26:26Z

i'll take another look over the weekend

s-alves10 · 2024-02-26T16:34:42Z

@ishpaul777 friendly bump

ishpaul777 · 2024-02-26T18:57:29Z

Can you please merge main, review comments have been addressed 👍 I'll work on checklist and videos

s-alves10 · 2024-02-26T23:28:02Z

Please take a look again @ishpaul777

ishpaul777 · 2024-02-27T04:48:50Z

I will complete this today @s-alves10

ishpaul777 · 2024-02-27T12:47:18Z

@s-alves10 I found while adjusting window width, the pages has a lot of space between them can you give a quick look to see if this comes from this PR (becuase i can't repro on staging)

Screen.Recording.2024-02-27.at.6.13.08.PM-1.mov

ishpaul777 · 2024-02-27T12:54:36Z

after entering a correct password, this screen shows for a brief moment (not repro on staging)

Screen.Recording.2024-02-27.at.6.22.42.PM.mov

ishpaul777 · 2024-02-27T12:57:16Z

after entering a wrong password it shows this screen instead of error

Screen.Recording.2024-02-27.at.6.25.49.PM.mov

s-alves10 · 2024-02-27T12:58:24Z

Let me check @ishpaul777

s-alves10 · 2024-02-27T14:31:24Z

@ishpaul777

I found while adjusting window width, the pages has a lot of space between them can you give a quick look to see if this comes from this PR (becuase i can't repro on staging)

I can reproduce this issue on staging

bandicam.2024-02-27.23-30-22-679.mp4

s-alves10 · 2024-02-27T19:43:34Z

@ishpaul777

I've fixed the above errors related to password. Please take a look

s-alves10 · 2024-02-29T00:10:17Z

Can you please take a look again? @ishpaul777

s-alves10 · 2024-03-01T14:27:16Z

@ishpaul777

ishpaul777 · 2024-03-01T17:50:03Z

Thanks for your patience @s-alves10 I'll priortize the review for tomorrow ending my day for today 🙇‍♂️

ishpaul777 · 2024-03-03T00:51:05Z

src/components/PDFView/index.js

-        // Use window height changes to toggle the keyboard. To maintain keyboard state
-        // on all platforms we also use focus/blur events. So we need to make sure here
-        // that we avoid redundant keyboard toggling.
-        // Minus 100px is needed to make sure that when the internet connection is
-        // disabled in android chrome and a small 'No internet connection' text box appears,
-        // we do not take it as a sign to open the keyboard


Why comment is removed ?

ishpaul777

just add the missing comment back rest LGTM 👍

puneetlath · 2024-03-03T01:28:15Z

src/components/PDFView/index.js

-        const ratioWidth = this.props.maxCanvasWidth / width;
-        const ratioArea = Math.sqrt(this.props.maxCanvasArea / nbPixels);
-        const ratio = Math.min(ratioHeight, ratioArea, ratioWidth);
+    const getDevicePixelRatio = useCallback(


Could we move this function outside? So we don't have to memoize it? And just pass it the props it needs to do the calculations as arguments?

puneetlath · 2024-03-03T01:28:56Z

src/components/PDFView/index.js

+     * It depends on a screen size. Also, the app should take into account the page borders.
+     * @returns {Number}
+     */
+    const calculatePageWidth = useCallback(() => {


Same question here. Can we move it outside the component function?

puneetlath · 2024-03-03T01:29:24Z

src/components/PDFView/index.js

-    calculatePageHeight(pageIndex) {
-        if (this.state.pageViewports.length === 0 || _.some(this.state.pageViewports, (viewport) => !viewport)) {
-            Log.warn('Dev error: calculatePageHeight() in PDFView called too early');
+    const calculatePageHeight = useCallback(


Same question about this function.

puneetlath · 2024-03-04T16:43:01Z

@ishpaul777 can you re-review and then ping me again when you're ready for me to take another look?

ishpaul777 · 2024-03-04T17:30:39Z

sure i'll ping 👍, @s-alves10 Can you address @puneetlath review comments

ishpaul777 · 2024-03-12T00:03:59Z

@s-alves10 Any updates?

puneetlath · 2024-03-13T16:51:27Z

@s-alves10 will you be able to take this to the finish line? If we don't hear back by tomorrow I'm going to proceed with hiring someone else.

s-alves10 · 2024-03-13T21:23:49Z

@puneetlath
Due to my health, I am not able to continue working for a while. Please go with other one.

puneetlath · 2024-03-13T21:27:00Z

Sorry to hear that @s-alves10 😞

ishpaul777 · 2024-03-21T20:05:46Z

@puneetlath Can we close this PR/ or add a hold in title so this dont fall overdue in K2

puneetlath · 2024-03-21T20:09:35Z

Good call. Closing it out and putting the issue on hold.

sangar-1028 added 4 commits February 19, 2024 11:06

refactor: migrate PDFView/index.js to function component

fd4c793

fix: lint error

ef91ae1

fix: use-constructor hook

72236b4

fix: remove state and use instance variable using ref for pageViewports

b22f55a

s-alves10 marked this pull request as ready for review February 20, 2024 07:02

s-alves10 requested a review from a team as a code owner February 20, 2024 07:02

melvin-bot bot requested review from ishpaul777 and removed request for a team February 20, 2024 07:03

This comment was marked as outdated.

Sign in to view

ishpaul777 reviewed Feb 21, 2024

View reviewed changes

s-alves10 requested a review from ishpaul777 February 21, 2024 16:37

sangar-1028 added 2 commits February 26, 2024 13:25

Merge branch 'main' into fix/issue-16186

1766bae

fix: add comments

1e53bdd

Merge branch 'main' into fix/issue-16186

3de3990

fix: reorder setting state

d49343f

fix: conflicts

f6f8ebf

ishpaul777 reviewed Mar 3, 2024

View reviewed changes

ishpaul777 approved these changes Mar 3, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath March 3, 2024 00:59

puneetlath requested changes Mar 3, 2024

View reviewed changes

sangar-1028 added 2 commits March 3, 2024 17:00

fix: add comments

494d182

Merge branch 'main' into fix/issue-16186

0fe777c

puneetlath closed this Mar 21, 2024

refactor: migrate PDFView/index.js to function component #36809

refactor: migrate PDFView/index.js to function component #36809

Conversation

s-alves10 commented Feb 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 20, 2024

s-alves10 commented Feb 21, 2024

ishpaul777 commented Feb 21, 2024

ishpaul777 commented Feb 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

This comment was marked as outdated.

ishpaul777 Feb 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ishpaul777 commented Feb 21, 2024

ishpaul777 commented Feb 22, 2024 • edited Loading

s-alves10 commented Feb 26, 2024

ishpaul777 commented Feb 26, 2024 • edited Loading

s-alves10 commented Feb 26, 2024

ishpaul777 commented Feb 27, 2024

ishpaul777 commented Feb 27, 2024 • edited Loading

ishpaul777 commented Feb 27, 2024

ishpaul777 commented Feb 27, 2024

s-alves10 commented Feb 27, 2024

s-alves10 commented Feb 27, 2024

s-alves10 commented Feb 27, 2024

s-alves10 commented Feb 29, 2024

s-alves10 commented Mar 1, 2024

ishpaul777 commented Mar 1, 2024

Choose a reason for hiding this comment

ishpaul777 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

puneetlath commented Mar 4, 2024

ishpaul777 commented Mar 4, 2024

ishpaul777 commented Mar 12, 2024

puneetlath commented Mar 13, 2024

s-alves10 commented Mar 13, 2024

puneetlath commented Mar 13, 2024

ishpaul777 commented Mar 21, 2024 • edited Loading

puneetlath commented Mar 21, 2024

s-alves10 commented Feb 19, 2024 •

edited

Loading

ishpaul777 commented Feb 21, 2024 •

edited

Loading

ishpaul777 Feb 21, 2024 •

edited

Loading

ishpaul777 commented Feb 22, 2024 •

edited

Loading

ishpaul777 commented Feb 26, 2024 •

edited

Loading

ishpaul777 commented Feb 27, 2024 •

edited

Loading

ishpaul777 commented Mar 21, 2024 •

edited

Loading