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

Fix unable to scroll PDF files in preview #21714

Merged
merged 5 commits into from
Jul 13, 2023
Merged

Conversation

hoangzinh
Copy link
Contributor

@hoangzinh hoangzinh commented Jun 27, 2023

Details

Fixed Issues

$ #20867
PROPOSAL: #20867 (comment)

Tests

Test case 1: View a normal PDF

  1. Go to any chat
  2. Click on the PDF file that has as least 2 pages
  3. Verify that we can scroll down/up the PDF file

Test case 2: View a encrypted PDF

  1. Go to any chat
  2. Click on the encrypted PDF file that has as least 2 pages
  3. Enter the correct password
  4. Verify that the PDF is loaded successfully
  5. Verify that we can scroll down/up the PDF file
  • Verify that no errors appear in the JS console

Offline tests

The fix is not related to network

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
    • 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
Screen.Recording.2023-06-28.at.00.43.19.-.web.mov
Mobile Web - Chrome
Screen.Recording.2023-06-28.at.00.50.29.-.android.chrome.mov
Mobile Web - Safari
Screen.Recording.2023-06-28.at.00.58.30.-.ios.safari.mov
Desktop
Screen.Recording.2023-06-28.at.00.46.33.-.desktop.mov
iOS
Screen.Recording.2023-06-28.at.00.56.33.-.ios.mp4
Android
Screen.Recording.2023-06-28.at.00.53.38.-.android.mp4

@hoangzinh hoangzinh marked this pull request as ready for review June 27, 2023 18:00
@hoangzinh hoangzinh requested a review from a team as a code owner June 27, 2023 18:00
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and removed request for a team June 27, 2023 18:00
@melvin-bot
Copy link

melvin-bot bot commented Jun 27, 2023

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

@abdulrahuman5196
Copy link
Contributor

@hoangzinh This change is causing the password screen to show up twice when using password protected pdf in native iOS and android. Could you kindly check on this?

Screen.Recording.2023-06-29.at.2.29.24.PM.mp4

@hoangzinh
Copy link
Contributor Author

nice catch @abdulrahuman5196 I will take a look

@hoangzinh
Copy link
Contributor Author

@abdulrahuman5196 fyi, I'm asking the author of previous PR to understand why do we need Pressable component here first #17647 (comment)

@abdulrahuman5196
Copy link
Contributor

@hoangzinh Why are we checking removal of pressable to fix this double request of password issue? Is it related?

@hoangzinh
Copy link
Contributor Author

@hoangzinh Why are we checking removal of pressable to fix this double request of password issue? Is it related?

The root cause of double request password issue of this PR is: this PR proposes a solution that when the PDF is loaded completed, we will remove Pressable component. In case of PDF has password, the onLoadComplete callback only be triggered when we enter password successfully. That means:

  • The PDFView renders 1st time with Pressable component wrapped, then when we enter password successfully
  • The PDFView renders 2nd time without Pressable component wrapped => It requests password form again.

So I would like to understand what are roles of Pressable component here, which cases we need it.

@alexxxwork
Copy link
Contributor

@hoangzinh @abdulrahuman5196 This Pressable is to replace TouchableWithoutFeedback and to hide arrows when PDF loading takes some time. Maybe we should handle the password protected PDFs case separately

@hoangzinh
Copy link
Contributor Author

Thanks @alexxxwork for providing this information. I will continue with my PR according to this.

@hoangzinh
Copy link
Contributor Author

@abdulrahuman5196 update so far, I still find best approaches in this case. Some explore directions:

  • Finding a way to make React doesn't remount the children component if the parent component is changed
  • I guess we need Pressable component here because when it's either showing password form or failed to load PDF, we can show arrow button to navigate to next attachment
    <KeyboardAvoidingView style={styles.flex1}>
    <PDFPasswordForm
    isFocused={this.props.isFocused}
    onSubmit={this.attemptPDFLoadWithPassword}
    onPasswordUpdated={() => this.setState({isPasswordInvalid: false})}
    isPasswordInvalid={this.state.isPasswordInvalid}
    shouldShowLoadingIndicator={this.state.shouldShowLoadingIndicator}
    />
    </KeyboardAvoidingView>

@abdulrahuman5196
Copy link
Contributor

@hoangzinh

Finding a way to make React doesn't remount the children component if the parent component is changed

I don't agree on this. This is the normal way how react components do. So wouldn't want to affect that.

I am not able to understand the second part? Could you provide more information?

@hoangzinh
Copy link
Contributor Author

I am not able to understand the second part? Could you provide more information?

Definitely, When I look into how PDFView is implemented in native app:

  • The onPress callback only passed to the PDF component here, so when it's rendered, we can press on it to trigger onPress callback
  • But when pdf is encrypted, we will show password form, and we don't have any logic to trigger onPress callback in this form
    {this.state.shouldRequestPassword && (
    <KeyboardAvoidingView style={styles.flex1}>
    <PDFPasswordForm
    isFocused={this.props.isFocused}
    onSubmit={this.attemptPDFLoadWithPassword}
    onPasswordUpdated={() => this.setState({isPasswordInvalid: false})}
    isPasswordInvalid={this.state.isPasswordInvalid}
    shouldShowLoadingIndicator={this.state.shouldShowLoadingIndicator}
    />
    </KeyboardAvoidingView>
    )}
  • Or in case PDF is failed to load, we don't have any logic to trigger onPress callback
    {this.state.failedToLoadPDF && (
    <View style={[styles.flex1, styles.justifyContentCenter]}>
    <Text style={[styles.textLabel, styles.textLarge]}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>
    </View>
    )}

@hoangzinh
Copy link
Contributor Author

@abdulrahuman5196 so my RCA for case of PDF is encrypted is. If we go with this solution

return props.onPress && !loadComplete ? (
<PressableWithoutFeedback
onPress={props.onPress}
style={containerStyles}
accessibilityRole="imagebutton"
accessibilityLabel={props.file.name || props.translate('attachmentView.unknownFilename')}
>
{children}
</PressableWithoutFeedback>
) : (
children
);

The onLoadComplete callback only triggered when we enter the password and the PDF is successfully loaded => It makes the element children in LOC above remounted again => the state password here will be reset => it makes us enter password twice.

So I think that, should we move component PressableWithoutFeedback here to inside the PDFView here so we will keep the component's states for the cases of PDF is encrypted.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jul 7, 2023

@hoangzinh I am fine with the above approach. Could you kindly make the change, so that i can test it thoroughly to see if some edge case comes up there as well?

@abdulrahuman5196
Copy link
Contributor

@deetergp We got an issue while applying this solution.
For password protected PDFs the password is requested twice on the native ios/android. #21714 (comment)
@hoangzinh has provided the root cause and its fix for the same #21714 (comment). I think the mentioned fix is fine IMO. Let me know your thoughts as well

@hoangzinh
Copy link
Contributor Author

hoangzinh commented Jul 10, 2023

@abdulrahuman5196 I just updated the PR with my latest proposal. Please free to test it in your side. Thanks.
The linter code failed is in another file that this PR is not touch so I will fix it after you test everything work well/or waiting someone fix in main branch

@deetergp
Copy link
Contributor

@deetergp We got an issue while applying this solution.
For password protected PDFs the password is requested twice on the native ios/android. #21714 (comment)
@hoangzinh has provided the root cause and its fix for the same #21714 (comment). I think the mentioned fix is fine IMO. Let me know your thoughts as well

@hoangzinh's fix for this bug sounds good to me as well. It's great that you caught it now and fixed it here! 🎉

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jul 13, 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 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-07-14.at.1.12.50.AM.mp4
Mobile Web - Chrome
az_recorder_20230714_011843.mp4
Mobile Web - Safari
Untitled.2.mp4
Desktop
Screen.Recording.2023-07-14.at.1.02.57.AM.mp4
iOS
Screen.Recording.2023-07-14.at.12.51.44.AM.mp4
Android
az_recorder_20230714_004452.mp4

@abdulrahuman5196
Copy link
Contributor

Thank you @deetergp for checking and confirming on the same. #21714 (comment)

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Changes looks good and works well. Reviewers checklist is also complete.

All yours @deetergp

🎀 👀 🎀
C+ Reviewed

@melvin-bot melvin-bot bot requested a review from deetergp July 13, 2023 20:00
Copy link
Contributor

@deetergp deetergp left a comment

Choose a reason for hiding this comment

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

Code looks good, thanks for the changes!

@deetergp deetergp merged commit 1cf6b0f into Expensify:main Jul 13, 2023
11 checks passed
@deetergp deetergp self-assigned this Jul 13, 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/deetergp in version: 1.3.41-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.41-3 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/deetergp in version: 1.3.42-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.41-3 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

@@ -169,6 +173,21 @@ class PDFView extends Component {
</View>
);
}

render() {
return this.props.onPress && !this.state.successToLoadPDF ? (
Copy link
Contributor

@allroundexperts allroundexperts Aug 20, 2023

Choose a reason for hiding this comment

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

Adding this condition introduced #23475 bug. this.props.onPress always returned true because it was defined in the default props.

return this.props.onPress ? (
<PressableWithoutFeedback
onPress={this.props.onPress}
style={[styles.flex1, styles.flexRow, styles.alignSelfStretch]}
Copy link
Contributor

Choose a reason for hiding this comment

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

adding styles.flexRow caused a regression where failed to load message is not properly visible on native #21714

@@ -169,6 +173,21 @@ class PDFView extends Component {
</View>
);
}

render() {
return this.props.onPress && !this.state.successToLoadPDF ? (
Copy link
Collaborator

Choose a reason for hiding this comment

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

This condition caused the #42103 (comment) bug. We should've disabled the component instead of conditional rendering.

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.

8 participants