Enhance Carousel Scrolling and Interaction in AttachmentCarousel #39930

kidroca · 2024-04-09T13:19:43Z

Details

Key changes include:

Pan Gesture Integration: Implemented a new gesture handler to allow smoother and more responsive scrolling through carousel items. This update leverages the react-native-gesture-handler for a fluid user experience.
Layout Optimization: Adjusted the layout calculations to ensure attachments render correctly across different device sizes. This change utilises useWindowDimensions for dynamic layout updates based on screen size changes.

These updates address issues related to carousel bugs, noted in several related tickets (e.g., #23546, #39833, #22318, #21177, and #31166).

Fixed Issues

$ #23546
PROPOSAL: #23546 (comment)

Tests

Verify Expected Behavior for Touch Screen Devices (iOS Safari, Android Chrome)

Open a chat containing multiple attachments.
Tap on any attachment to open the attachment carousel.
Swipe left or right to navigate through the attachments.
- Ensure that swiping scrolls through the attachments one at a time and each attachment snaps into view centrally.

Verify Bug Fixes on iOS and macOS Safari

Bug #23546: Incorrect Image Displayed in HT Report

Open a chat with multiple attachments.
Open and close several attachments randomly.
Confirm that the attachment carousel always opens with the attachment that was selected.

Bug #22318: Attachment Skipping When Using Navigation Arrows

Open a chat with multiple attachments.
Select an attachment to open the attachment carousel.
Use the on-screen arrow keys to navigate through the attachments.
- Verify that pressing the arrows moves the view to the next or previous attachment one at a time, without skipping.

Bug #31166: Inability to Open Protected PDFs in Chat View for Old Accounts

Open a chat containing password-protected PDF attachments.
Select a password-protected PDF to attempt opening it.
Enter the correct password in the provided field.
Tap on the eye icon within the password field to toggle visibility (ensure this does not trigger any bugs).
Click "Confirm" to proceed.
Verify that the PDF opens and can be viewed without issues.

Offline tests

N/A

QA Steps

Same as the Tests section above, same behavior is expected for staging and prod

PR Author Checklist

Screenshots/Videos

Android: Native

Android.Emulator.-.Pixel_7_API_33_5554.2024-05-13.11-15-55.mp4

Android: mWeb Chrome

Screen.Recording.2024-04-22.at.21.52.55.mov

iOS: Native

Screen.Recording.2024-04-22.at.21.19.45.mov

Screen.Recording.2024-04-22.at.21.20.26.mov

iOS: mWeb Safari

Screen.Recording.2024-04-09.at.16.34.25.mov

Screen.Recording.2024-04-22.at.21.27.10.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-09.at.16.26.17.mov

Screen.Recording.2024-04-22.at.21.05.02.mov

MacOS: Desktop

Screen.Recording.2024-04-22.at.21.55.45.mov

melvin-bot · 2024-04-22T19:05:04Z

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

kidroca · 2024-04-22T19:12:56Z

I've been struggling to build and test Android

There shouldn't be any change as I've only modified the web specific Attachment Carousel, I'll try to build again tomorrow, but I'll appreciate it if someone can confirm in the meantime.

- Fixed an issue with carousel scrolling in the AttachmentCarousel component - Implemented a new pan gesture for smoother scrolling experience - Adjusted layout calculations for optimal rendering of attachments Related to: - Expensify#23546 - Expensify#39833 - Expensify#22318 - Expensify#21177 - Expensify#31166

parasharrajat · 2024-04-22T19:39:43Z

src/components/Attachments/AttachmentCarousel/AttachmentCarouselCellRenderer.tsx

What's the reason to remove this?

We need accurate cell width to make the pan gesture responder work, so we moved the calculation to happen on the list level. This makes the custom cell renderer component redundant and have the benefit of not doing the same calculation per each rendered cell

parasharrajat · 2024-04-24T19:22:58Z

src/components/Attachments/AttachmentCarousel/index.tsx

@@ -29,16 +31,23 @@ const viewabilityConfig = {
    itemVisiblePercentThreshold: 95,
 };

+const MIN_FLING_VELOCITY = 500;


Is this value custom or picked from FlatList?

This custom value is used to gauge the speed of a user's swipe:

A quick lateral swipe advances to the previous or next image based on the direction.

A slow drag that releases after moving the image more than 50% of its width will also transition to the previous or next image.

A slow drag that moves a minimal distance and is then abandoned (e.g., less than 50%) will cause the image to snap back to the center.

I determined this value through testing typical swiping motions intended to fling to the next image. However, I am open to suggestions for an optimized value. Given that Software Mansion is the creator of the gesture handler used here and is involved in this project, maybe we can give them a shout?

parasharrajat · 2024-04-30T20:05:10Z

BUG: WEb: Resizing the window changes the image.

Screen.Recording.2024-05-01.at.1.34.13.AM.mov

parasharrajat · 2024-05-01T13:09:32Z

BUG: IOS Safari: Unexpected scroll behaviour.

I wasn't able to reproduce this consistently.

Steps(Possible):

have two Pdfs sent as messages one after another.
Open first PDF.
Click on next arrow and try to horizontal scroll as well.

RPReplay_Final1714512789.MP4

kidroca · 2024-05-02T17:27:19Z

I'll investigate the issue and try to find a fix. However, since the bugs don't appear to be critical or common, it might be more efficient to address them in a follow-up PR. Can you confirm what would be the priority?

CortneyOfstad · 2024-05-06T14:24:04Z

@parasharrajat any update on @kidroca's comment here?

parasharrajat · 2024-05-06T18:17:42Z

Can we solve #39930 (comment) @kidroca for now? This looks like a thing that will become a issue for Desktop users.

parasharrajat · 2024-05-07T10:23:06Z

@kidroca Thoughts?

- Added useEffect hook to readjust scroll position in AttachmentCarousel component when window width is resized to ensure correct display of images. - Updated logic to automatically scroll to the correct index when window width changes.

…ng-attachment

kidroca · 2024-05-07T13:09:31Z

Can we solve #39930 (comment) @kidroca for now? This looks like a thing that will become a issue for Desktop users.

Synced with main and pushed an update to fix issues around resizing: 3a1e687

parasharrajat · 2024-05-07T13:13:38Z

Thanks. Checking...

parasharrajat · 2024-05-07T19:19:45Z

I was able to reproduce this #39930 (comment) again so it seems that it will be a real issue for users.

As we are on merge freeze, we have got some time to spend on this.

parasharrajat · 2024-05-08T17:12:26Z

@kidroca Thoughts?

kidroca · 2024-05-09T10:52:36Z

I was able to reproduce this #39930 (comment) again so it seems that it will be a real issue for users.

I couldn't reproduce this bug. I was able to tap, hold, and prevent the transition to the next page after pressing the next arrow, but it didn't result in any unusual behaviour.

Could you describe the problem you're experiencing after pressing the next button and then trying to drag? In the video, it seems like the pages are no longer aligning correctly, but I can't tell if that's the case or if you're still dragging. Do you suggest we should disable manual scrolling while the transition to the next page is running?

parasharrajat · 2024-05-14T19:10:18Z

Just noticed that the previous report is not related to this PR.

parasharrajat · 2024-05-14T19:51:33Z

I will have the final testing done tomorrow and if everything looks OK, I will mark this ready for merge.

parasharrajat · 2024-05-15T18:26:05Z

Screenshots

🔲 iOS / native

Screen.Recording.2024-05-16.at.1.04.20.AM.mov

🔲 iOS / Safari

Screen.Recording.2024-05-15.at.11.48.27.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-05-15.at.11.46.08.PM.mov

🔲 MacOS / Safari

Screen.Recording.2024-05-15.at.11.01.08.PM.mov

🔲 Android / Chrome

Screen.Recording.2024-05-15.at.11.51.52.PM.mov

🔲 Android / native

Screen.Recording.2024-05-16.at.12.14.01.AM.mov

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

deetergp

Looks good and tests well. Not merging because we are in a merge freeze till at least next week.

deetergp · 2024-05-16T20:37:47Z

src/components/Attachments/AttachmentCarousel/index.tsx

-        [activeSource, canUseTouchScreen, setShouldShowArrows, shouldShowArrows],
+        [activeSource, canUseTouchScreen, cellWidth, setShouldShowArrows, shouldShowArrows, styles.h100],
+    );
+    /** Pan gesture handing swiping through attachments on touch screen devices */


NAB

Suggested change

/** Pan gesture handing swiping through attachments on touch screen devices */

/** Pan gesture handling swiping through attachments on touch screen devices */

deetergp · 2024-05-24T17:46:32Z

We are unfortunately still in a merge freeze, particularly for larger PRs like this one. We'll hopefully be back to full steam by Wednesday.

deetergp · 2024-05-28T21:05:10Z

Okay, we have thawed out from our freeze, so I am merging this now.

OSBotify · 2024-05-29T09:41:51Z

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

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

OSBotify · 2024-05-30T21:24:40Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:36:38Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

kidroca mentioned this pull request Apr 9, 2024

[HOLD for payment 2024-04-25] Attachment - Wrong PDF is opened #39833

Closed

6 tasks

kidroca force-pushed the kidroca/fix/carousel-opens-on-wrong-attachment branch from 3956014 to d0e7486 Compare April 9, 2024 13:38

This was referenced Apr 9, 2024

[ON HOLD — #23546][$1000] Chat - Several images at once are skipped when switching attachments with arrows #22318

Closed

[HOLD FOR #23546][$500] mWeb - PDF - When typing password, revealing it and confirm, another attachment is displayed #35197

Closed

CortneyOfstad mentioned this pull request Apr 17, 2024

[HOLD for payment 2024-06-06] [$2000] Wrong Image opens on HT Report in Safari #23546

Closed

6 tasks

kidroca force-pushed the kidroca/fix/carousel-opens-on-wrong-attachment branch from d0e7486 to 4f453b0 Compare April 22, 2024 19:02

kidroca marked this pull request as ready for review April 22, 2024 19:04

kidroca requested a review from a team as a code owner April 22, 2024 19:05

melvin-bot bot requested review from parasharrajat and removed request for a team April 22, 2024 19:05

kidroca added 3 commits April 22, 2024 22:26

⚡️ chore(AttachmentCarousel): fix formatting issues

155bf0e

Remove unused AttachmentCarouselCellRenderer.tsx

a02bb10

kidroca force-pushed the kidroca/fix/carousel-opens-on-wrong-attachment branch from 4f453b0 to a02bb10 Compare April 22, 2024 19:27

parasharrajat reviewed Apr 22, 2024

View reviewed changes

parasharrajat reviewed Apr 24, 2024

View reviewed changes

kidroca added 2 commits May 7, 2024 15:35

Merge branch 'refs/heads/main' into kidroca/fix/carousel-opens-on-wro…

eed77be

…ng-attachment

Disable eslint rule for exhaustive-deps in AttachmentCarousel

3089399

This comment was marked as off-topic.

Sign in to view

parasharrajat approved these changes May 15, 2024

View reviewed changes

melvin-bot bot requested a review from deetergp May 15, 2024 19:36

deetergp approved these changes May 16, 2024

View reviewed changes

deetergp merged commit b7233ce into Expensify:main May 28, 2024
17 of 18 checks passed

github-actions bot mentioned this pull request May 29, 2024

Deploy Checklist: New Expensify 2024-05-29 #42741

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance Carousel Scrolling and Interaction in AttachmentCarousel #39930

Enhance Carousel Scrolling and Interaction in AttachmentCarousel #39930

kidroca commented Apr 9, 2024 •

edited

Loading

melvin-bot bot commented Apr 22, 2024

kidroca commented Apr 22, 2024

parasharrajat Apr 22, 2024

kidroca Apr 22, 2024

parasharrajat Apr 24, 2024

kidroca Apr 26, 2024

parasharrajat commented Apr 30, 2024

parasharrajat commented May 1, 2024 •

edited

Loading

kidroca commented May 2, 2024

CortneyOfstad commented May 6, 2024

parasharrajat commented May 6, 2024

parasharrajat commented May 7, 2024

kidroca commented May 7, 2024

parasharrajat commented May 7, 2024

parasharrajat commented May 7, 2024

parasharrajat commented May 8, 2024

kidroca commented May 9, 2024

This comment was marked as off-topic.

parasharrajat commented May 14, 2024

parasharrajat commented May 14, 2024

parasharrajat commented May 15, 2024 •

edited

Loading

parasharrajat left a comment

deetergp left a comment

deetergp May 16, 2024

deetergp commented May 24, 2024

deetergp commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

	/** Pan gesture handing swiping through attachments on touch screen devices */
	/** Pan gesture handling swiping through attachments on touch screen devices */

Enhance Carousel Scrolling and Interaction in AttachmentCarousel #39930

Enhance Carousel Scrolling and Interaction in AttachmentCarousel #39930

Conversation

kidroca commented Apr 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Verify Expected Behavior for Touch Screen Devices (iOS Safari, Android Chrome)

Verify Bug Fixes on iOS and macOS Safari

Bug #23546: Incorrect Image Displayed in HT Report

Bug #22318: Attachment Skipping When Using Navigation Arrows

Bug #31166: Inability to Open Protected PDFs in Chat View for Old Accounts

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 22, 2024

kidroca commented Apr 22, 2024

parasharrajat Apr 22, 2024

Choose a reason for hiding this comment

kidroca Apr 22, 2024

Choose a reason for hiding this comment

parasharrajat Apr 24, 2024

Choose a reason for hiding this comment

kidroca Apr 26, 2024

Choose a reason for hiding this comment

parasharrajat commented Apr 30, 2024

parasharrajat commented May 1, 2024 • edited Loading

kidroca commented May 2, 2024

CortneyOfstad commented May 6, 2024

parasharrajat commented May 6, 2024

parasharrajat commented May 7, 2024

kidroca commented May 7, 2024

parasharrajat commented May 7, 2024

parasharrajat commented May 7, 2024

parasharrajat commented May 8, 2024

kidroca commented May 9, 2024

This comment was marked as off-topic.

parasharrajat commented May 14, 2024

parasharrajat commented May 14, 2024

parasharrajat commented May 15, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Safari

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

deetergp left a comment

Choose a reason for hiding this comment

deetergp May 16, 2024

Choose a reason for hiding this comment

deetergp commented May 24, 2024

deetergp commented May 28, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

kidroca commented Apr 9, 2024 •

edited

Loading

parasharrajat commented May 1, 2024 •

edited

Loading

parasharrajat commented May 15, 2024 •

edited

Loading