Fix: android pdf scrolling issue by HezekielT · Pull Request #30050 · Expensify/App

HezekielT · 2023-10-20T04:36:10Z

Details

Users couldn’t scroll up and down smoothly in a pdf attachment due to a conflict between vertical(react-native-pdf’s) scroll event and horizontal(pager’s) scroll event. This PR aims to address this conflict by disabling pager’s scroll event when the scroll is in a vertical direction and enabling it when the scroll is in a horizontal direction.

Fixed Issues

$ #23417
PROPOSAL: #23417 (comment)

Tests

Open any report
Click on + of the composer.
Select Add attachment > Choose document > upload a multi-page pdf file.
Open the pdf file and scroll up and down.
Verify the scroll is smooth.
Close the attachment and Click on + of the composer again.
Upload an image.
Open the image and swipe to the left.
Verify the previously sent pdf is opened.
Scroll through the pdf up and down.
Verify the scroll is smooth.

Verify that no errors appear in the JS console

Offline tests

Make sure the uploaded pdf and image are loaded first by opening them.
Turn off the wifi.
Scroll through the pdf up and down.
Verify the scroll is smooth.
Swipe to the left/right.
Verify the image is opened.

QA Steps

Same as Tests Section.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

fixPdfScrollingIssue.mov

Android: mWeb Chrome

fixPdfScrollingIssueChrome.mov

iOS: Native

Screencast-iOS-native-Pdf-Scrolling-issue.mov

iOS: mWeb Safari

Screencast-iOS-safari-pdf-scrolling-issue.mov

MacOS: Chrome / Safari

fixScrollingIssueWeb.mov

MacOS: Desktop

Screencast-desktop-pdf-scrolling-issue.mov

melvin-bot · 2023-10-20T05:20:13Z

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

HezekielT · 2023-10-20T05:22:45Z

@mollfpr I will add the screencast for desktop in moment. other than that, the pr is ready for review. Thanks!

HezekielT · 2023-10-20T05:23:41Z

@jjcoffee Sorry for the bump. I don't know why melvin requested review from you.

mollfpr

Sorry for the ping @jjcoffee I'll review the PR 🙏

HezekielT · 2023-10-20T05:45:02Z

@mollfpr I have added the screencast for desktop.

mollfpr · 2023-10-20T13:47:16Z

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

30050.Web.mp4

Mobile Web - Chrome

30050.mWeb-Chrome.mp4

Mobile Web - Safari

30050.mWeb-Safari.mp4

Desktop

30050.Desktop.mp4

iOS

30050.iOS.mp4

Android

30050.Android.mp4

mollfpr

LGTM and tests well 👍

@HezekielT Could you add details on the PR description?

All yours @Gonals

HezekielT · 2023-10-20T16:16:51Z

@HezekielT Could you add details on the PR description?

@mollfpr Done.

cc @Gonals

HezekielT · 2023-10-23T10:23:47Z

@Gonals Friendly bump for review

src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js

mollfpr

Tested on the latest commit and still good.

Friendly bump @Gonals for final review.

mollfpr · 2023-10-30T14:08:20Z

Here's what I got in my local.

diff --git a/src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js b/src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js
index e0f3e9ab84..c56bda6972 100644
--- a/src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js
+++ b/src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js
@@ -1,5 +1,5 @@
-import React, {memo, useCallback, useContext, useEffect} from 'react';
 import PropTypes from 'prop-types';
+import React, {memo, useCallback, useContext, useEffect} from 'react';
 import AttachmentCarouselPagerContext from '@components/Attachments/AttachmentCarousel/Pager/AttachmentCarouselPagerContext';
 import PDFView from '@components/PDFView';
 import {attachmentViewPdfDefaultProps, attachmentViewPdfPropTypes} from './propTypes';
diff --git a/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.android.js b/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.android.js
index 3a5f39e188..7c3949f3f9 100644
--- a/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.android.js
+++ b/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.android.js
@@ -1,11 +1,11 @@
 import React, {memo, useCallback, useContext} from 'react';
-import {View, StyleSheet} from 'react-native';
+import {StyleSheet, View} from 'react-native';
 import {Gesture, GestureDetector} from 'react-native-gesture-handler';
 import Animated, {useSharedValue} from 'react-native-reanimated';
 import AttachmentCarouselPagerContext from '@components/Attachments/AttachmentCarousel/Pager/AttachmentCarouselPagerContext';
 import styles from '@styles/styles';
 import BaseAttachmentViewPdf from './BaseAttachmentViewPdf';
-import {attachmentViewPdfPropTypes, attachmentViewPdfDefaultProps} from './propTypes';
+import {attachmentViewPdfDefaultProps, attachmentViewPdfPropTypes} from './propTypes';

 function AttachmentViewPdf(props) {
     const attachmentCarouselPagerContext = useContext(AttachmentCarouselPagerContext);
diff --git a/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.ios.js b/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.ios.js
index 94440e1d17..103ff29276 100644
--- a/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.ios.js
+++ b/src/components/Attachments/AttachmentView/AttachmentViewPdf/index.ios.js
@@ -1,6 +1,6 @@
 import React, {memo} from 'react';
 import BaseAttachmentViewPdf from './BaseAttachmentViewPdf';
-import {attachmentViewPdfPropTypes, attachmentViewPdfDefaultProps} from './propTypes';
+import {attachmentViewPdfDefaultProps, attachmentViewPdfPropTypes} from './propTypes';

 function AttachmentViewPdf(props) {
     return (

src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js

HezekielT · 2023-10-30T14:24:35Z

@mollfpr Looks like the lint test has passed. Thank you very much for the diff. It solved the issue! 🙏

HezekielT · 2023-10-31T13:44:02Z

@Gonals Friendly bump for review. 🙏

HezekielT · 2023-11-02T12:01:08Z

@mollfpr It seems @Gonals is OOO. I have a question. Given that the PR was raised before the announcement, will the 9 day penalty be applied to it even though you approved it in just one day after it was raised? I believe if @Gonals had been available, it would have been eligible for the bonus.

OSBotify · 2023-11-02T13:33:37Z

✋ 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-11-06T22:34:25Z

🚀 Deployed to staging by https://github.com/Gonals in version: 1.3.96-0 🚀

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

situchan · 2023-11-07T11:44:36Z

This PR caused a few deploy blockers: #30977 #30979

mollfpr · 2023-11-07T11:46:18Z

@HezekielT Could you check the issue?

HezekielT · 2023-11-07T12:29:48Z

@mollfpr I will check it now.

HezekielT · 2023-11-07T13:07:03Z

@mollfpr I already have a solution for both issues. Let me test it on all platforms and then I will raise a PR.

OSBotify · 2023-11-09T22:51:58Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T15:48:54Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

akinwale · 2024-11-02T03:54:28Z

~~This PR caused a regression on Android native where the PDF being zoomed in isn't taken into account when attempting to scroll left / right to change the currently viewed attachment.~~

The regression was identified elsewhere.

HezekielT · 2024-11-02T04:54:10Z

@akinwale I think you meant #33756(comment), we did take the zoomed pdf into account at that time and this pr didn't cause that issue.

https://github.com/Expensify/App/pull/30050/files#diff-88a0bc2bc999bbbe459ca136dda591d1cd9452aa0bb449677fdea1e9c435d4c6R21-R24

This is the PR that cause the issue by removing it.

HezekielT marked this pull request as ready for review October 20, 2023 05:20

HezekielT requested a review from a team as a code owner October 20, 2023 05:20

melvin-bot bot requested review from jjcoffee and removed request for a team October 20, 2023 05:20

HezekielT mentioned this pull request Oct 20, 2023

[$2000] Android- PDF Scrolling Issue: Difficulty in Navigating Through Pages #23417

Closed

6 tasks

mollfpr reviewed Oct 20, 2023

View reviewed changes

mollfpr approved these changes Oct 20, 2023

View reviewed changes

HezekielT closed this Oct 24, 2023

HezekielT force-pushed the fix--Android-pdf-scrolling-issue branch from 8a45cd7 to d282473 Compare October 24, 2023 06:06

HezekielT reopened this Oct 24, 2023

mollfpr reviewed Oct 25, 2023

View reviewed changes

src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js Outdated Show resolved Hide resolved

mollfpr approved these changes Oct 25, 2023

View reviewed changes

HezekielT added 6 commits October 30, 2023 06:44

fix: resolve conflict

d7fe00b

remove unnecessary change

56b8969

fix lint issue

864314d

fix unused variables

58b8541

Rename updateScaleRef

0e85cc5

fix: resolve conflict

73d1d0d

HezekielT closed this Oct 30, 2023

HezekielT force-pushed the fix--Android-pdf-scrolling-issue branch from 8043738 to e99c297 Compare October 30, 2023 03:58

fix: resolve conflict

d0ca77b

HezekielT reopened this Oct 30, 2023

run prettier

8fd691c

mollfpr reviewed Oct 30, 2023

View reviewed changes

src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.js Outdated Show resolved Hide resolved

fix lint issues

892ea85

call updateScale in onScaleChanged instead of passing it as a prop

7b5ec6b

HezekielT requested a review from mollfpr October 30, 2023 15:48

mollfpr approved these changes Oct 30, 2023

View reviewed changes

melvin-bot bot requested a review from Gonals October 30, 2023 17:58

Merge branch 'Expensify:main' into fix--Android-pdf-scrolling-issue

373d983

Gonals approved these changes Nov 2, 2023

View reviewed changes

Gonals merged commit c79529a into Expensify:main Nov 2, 2023

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

bernhardoj mentioned this pull request Nov 7, 2023

[HOLD for payment 2023-11-21] [HOLD for payment 2023-11-17] [$500] Android - Attachments-Password protected file preview is not shown #30977

Closed

6 tasks

Beamanator mentioned this pull request Nov 7, 2023

[$500] Android - Chat - Attachment - Preview of a multi-page PDF cannot be scrolled #30979

Closed

6 tasks

HezekielT mentioned this pull request Nov 7, 2023

fix: pdf send attachment regression #30995

Merged

59 tasks

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

Beamanator mentioned this pull request Nov 10, 2023

[$1000] mWeb - Cannot open protected PDF in chat view while logged into an old account #31166

Closed

6 tasks

bernhardoj mentioned this pull request Sep 26, 2024

[HOLD for payment 2024-11-05] [$250] Android - Attachment - Android - I can to switch to another attachment in PDF zoomed state #49761

Closed

6 tasks

Conversation

HezekielT commented Oct 20, 2023 • edited 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!

melvin-bot bot commented Oct 20, 2023

Uh oh!

HezekielT commented Oct 20, 2023

Uh oh!

HezekielT commented Oct 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

HezekielT commented Oct 20, 2023

Uh oh!

mollfpr commented Oct 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

HezekielT commented Oct 20, 2023

Uh oh!

HezekielT commented Oct 23, 2023

Uh oh!

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Oct 30, 2023

Uh oh!

Uh oh!

HezekielT commented Oct 30, 2023

Uh oh!

HezekielT commented Oct 31, 2023

Uh oh!

HezekielT commented Nov 2, 2023

Uh oh!

OSBotify commented Nov 2, 2023

Uh oh!

OSBotify commented Nov 6, 2023

Uh oh!

situchan commented Nov 7, 2023

Uh oh!

mollfpr commented Nov 7, 2023

Uh oh!

HezekielT commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HezekielT commented Nov 7, 2023

Uh oh!

OSBotify commented Nov 9, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

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

Uh oh!

Uh oh!

HezekielT commented Nov 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

HezekielT commented Oct 20, 2023 •

edited

Loading

HezekielT commented Oct 20, 2023 •

edited

Loading

mollfpr commented Oct 20, 2023 •

edited

Loading

HezekielT commented Nov 7, 2023 •

edited

Loading

akinwale commented Nov 2, 2024 •

edited

Loading