[TS migration] Migrate 'PDFView' component to TypeScript by pac-guerreiro · Pull Request #39011 · Expensify/App

pac-guerreiro · 2024-03-26T19:05:16Z

Details

Fixed Issues

$ #25151
PROPOSAL: N/A

Tests

On any chat, click on the + sign and then select Add attachment
Select a PDF file
Confirm that the PDF preview renders correctly then click on send
On the same chat, click on the thumbnail of the attachment you just uploaded
Confirm that the PDF preview renders correctly

Offline tests

Same as tests.

QA Steps

Same as tests.

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

fabioh8010 · 2024-03-27T09:28:38Z

    const theme = useTheme();
    const styles = useThemeStyles();
+    const {translate} = useLocalize();
    return (


Suggested change

return (

return (

ishpaul777 · 2024-03-28T15:44:04Z

coming from a related issue #16186, will take this as C+

ishpaul777 · 2024-03-28T15:46:23Z

@pac-guerreiro looks like you have some comments to resolve

…pescript

pac-guerreiro · 2024-03-29T17:40:11Z

@fabioh8010 @kubabutkiewicz @ishpaul777

All feedback addressed, tests added, author checklist complete and screenshots added!

blazejkustra · 2024-04-02T08:58:03Z

+    const renderPDFView = () => {
+        const outerContainerStyle = [styles.w100, styles.h100, styles.justifyContentCenter, styles.alignItemsCenter];
+
+        return (
+            <View
+                style={outerContainerStyle}
+                tabIndex={0}
+            >
+                <PDFPreviewer
+                    contentContainerStyle={style as CSSProperties}
+                    file={sourceURL}
+                    pageMaxWidth={variables.pdfPageMaxWidth}
+                    isSmallScreen={isSmallScreenWidth}
+                    maxCanvasWidth={maxCanvasWidth}
+                    maxCanvasHeight={maxCanvasHeight}
+                    maxCanvasArea={maxCanvasArea}
+                    LoadingComponent={<FullScreenLoadingIndicator />}
+                    ErrorComponent={<Text style={errorLabelStyles}>{translate('attachmentView.failedToLoadPDF')}</Text>}
+                    renderPasswordForm={({isPasswordInvalid, onSubmit, onPasswordChange}) => (
+                        <PDFPasswordForm
+                            isFocused={!!isFocused}
+                            isPasswordInvalid={isPasswordInvalid}
+                            onSubmit={onSubmit}
+                            onPasswordUpdated={onPasswordChange}
+                            onPasswordFieldFocused={toggleKeyboardOnSmallScreens}
+                        />
+                    )}
+                />
+            </View>
+        );
+    };


Shouldn't this be a separate component? This looks like a big calculation each time PDFView rerenders 😄

I don't think there's a problem here but what do you think @fabioh8010?

I would avoid this kind of refactor right now, let's focus on the migration only

ishpaul777 · 2024-04-02T20:36:07Z

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 && <MxyComponent />.
- 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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: mWeb Chrome

Record_2024-04-03-20-24-14.mp4

iOS: Native

Screen.Recording.2024-04-03.at.7.46.00.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-03.at.7.39.55.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-03.at.7.35.20.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-03.at.8.41.43.PM-1.mov

melvin-bot · 2024-04-03T07:23:20Z

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

pac-guerreiro · 2024-04-03T07:26:46Z

@roryabraham @mountiny @cubuspl42

@ishpaul777 is the C+ reviewing this PR 😄

ishpaul777 · 2024-04-03T09:45:50Z

@pac-guerreiro Can you please merge main

mountiny · 2024-04-03T12:36:34Z

Assigned @roryabraham do you want to handle this one or should I go ahead?

fabioh8010 · 2024-04-03T15:57:05Z

@pac-guerreiro Can you please merge main

@pac-guerreiro bump

ishpaul777

LGTM!

melvin-bot · 2024-04-03T16:14:18Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25151 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

ishpaul777 · 2024-04-03T16:18:20Z

looks good otherwise! but we should merge main before merging!

…pescript

pac-guerreiro · 2024-04-03T17:19:43Z

@ishpaul777 @fabioh8010 just merged main into this branch! sorry for the delay!

blazejkustra · 2024-04-04T07:51:47Z

@ishpaul777 Can you approve again so an internal is assigned? Thanks!

OSBotify · 2024-04-04T17:28:23Z

✋ 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 · 2024-04-08T11:08:38Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-08T13:05:16Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-10T17:22:53Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

refactor(typescript): migrate PDFView

775a951

pac-guerreiro mentioned this pull request Mar 26, 2024

[HOLD #33434][$250] Migrate index.js to function component #16186

Closed

1 task

fabioh8010 reviewed Mar 27, 2024

View reviewed changes

pac-guerreiro added 3 commits March 28, 2024 22:39

Merge branch 'main' into pac-guerreiro/refactor/migrate-pdfview-to-ty…

92f341f

…pescript

refactor(typescript): apply pull request suggestions

ed98dda

Merge branch 'main' into pac-guerreiro/refactor/migrate-pdfview-to-ty…

73821b9

…pescript

kubabutkiewicz approved these changes Apr 2, 2024

View reviewed changes

blazejkustra approved these changes Apr 2, 2024

View reviewed changes

pac-guerreiro marked this pull request as ready for review April 3, 2024 07:23

pac-guerreiro requested a review from a team as a code owner April 3, 2024 07:23

melvin-bot Bot requested review from jakub-trzebiatowski and removed request for a team April 3, 2024 07:23

mountiny requested review from ishpaul777 and removed request for jakub-trzebiatowski April 3, 2024 12:36

mountiny assigned pac-guerreiro Apr 3, 2024

ishpaul777 approved these changes Apr 3, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/refactor/migrate-pdfview-to-ty…

3eab96f

…pescript

ishpaul777 approved these changes Apr 4, 2024

View reviewed changes

melvin-bot Bot requested a review from AndrewGable April 4, 2024 09:30

AndrewGable approved these changes Apr 4, 2024

View reviewed changes

AndrewGable merged commit 709fb40 into Expensify:main Apr 4, 2024

github-actions Bot mentioned this pull request Apr 8, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

This was referenced Apr 12, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807 Derevyaa/Expensify-App#1

Closed

Deploy Checklist: New Expensify 2024-04-09 #39808 Derevyaa/Expensify-App#2

Closed

ishpaul777 mentioned this pull request May 14, 2024

[TS migration] Migrate 'PDFView' component to TypeScript #25151

Closed

Conversation

pac-guerreiro commented Mar 26, 2024 • edited by mountiny Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

fabioh8010 Mar 27, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ishpaul777 commented Mar 28, 2024

Uh oh!

ishpaul777 commented Mar 28, 2024

Uh oh!

pac-guerreiro commented Mar 29, 2024

Uh oh!

blazejkustra Apr 2, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro Apr 2, 2024

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Apr 2, 2024

Choose a reason for hiding this comment

Uh oh!

ishpaul777 commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Apr 3, 2024

Uh oh!

pac-guerreiro commented Apr 3, 2024

Uh oh!

ishpaul777 commented Apr 3, 2024

Uh oh!

mountiny commented Apr 3, 2024

Uh oh!

fabioh8010 commented Apr 3, 2024

Uh oh!

ishpaul777 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Apr 3, 2024

Uh oh!

ishpaul777 commented Apr 3, 2024

Uh oh!

pac-guerreiro commented Apr 3, 2024

Uh oh!

blazejkustra commented Apr 4, 2024

Uh oh!

OSBotify commented Apr 4, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

OSBotify commented Apr 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

pac-guerreiro commented Mar 26, 2024 •

edited by mountiny

Loading

ishpaul777 commented Apr 2, 2024 •

edited

Loading