Fix: Don't add new content an already opened carousel #18651

kidroca · 2023-05-09T16:40:15Z

Details

Remove the componentDidUpdate handling responsible for remapping attachments in new comments. We aim to prevent the carousel content from updating while the user is actively viewing it, as this can lead to unexpected behavior such as the removal of an image the user is currently viewing.

Fixed Issues

$ #17743
PROPOSAL: #17743 (comment)

Tests

Test 1: Adding Attachments

Objective: Verify that adding attachments does not cause unusual behavior when the carousel is open.

Set up a chat between two users (User A and User B).
Have User A open the carousel and navigate to the very first image.
Have User B send a new attachment.

Expected Outcomes:

The new attachment should not be automatically added to the carousel.
User A must close and reopen the carousel to see the new image.
The currently viewed image in the carousel should remain the same.
Refer to the example video in the screenshot section: Web / Bug no longer occurs.

Offline tests

N/A You need to be online to receive attachments

QA Steps

Test 1: Adding Attachments

Objective: Verify that adding attachments does not cause unusual behavior when the carousel is open.

Set up a chat between two users (User A and User B).
Have User A open the carousel and navigate to the very first image.
Have User B send a new attachment.

Expected Outcomes:

The new attachment should not be automatically added to the carousel.
User A must close and reopen the carousel to see the new image.
The currently viewed image in the carousel should remain the same.
Refer to the example video in the screenshot section: Web / Bug no longer occurs.

PR Author Checklist

Screenshots/Videos

Web

Bug no longer occurs

Bug.no.longer.occurs.mp4

Removing image does not disturb carousel

Removing.image.does.not.disturb.carousel.mp4

Mobile Web - Chrome

2023-05-11_13-37-08.mp4

Mobile Web - Safari

Works.on.mWeb.mov

Desktop

iOS

Adding.image.does.not.disturb.carousel.mov

Android

2023-05-09_20-35-41.mp4

melvin-bot · 2023-05-09T17:43:04Z

@cead22 @sobitneupane One of you needs to 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]

sobitneupane

I am getting some weird issues in mWeb/Safari. In a chat with multiple images, when I press on an image, the carousel opens up with another image. It is reproducible in staging as well.

Untitled.mov

sobitneupane · 2023-05-10T08:09:48Z

Test 2 in Tests does not pass in mWeb/Chrome and mWeb/Safari.

Screen.Recording.2023-05-10.at.13.53.46.mov

kidroca · 2023-05-10T12:39:31Z

@sobitneupane
I was unable to reproduce the first bug you mentioned, but since it's already on staging, it is not a consequence of this PR.

I did manage to reproduce the second bug, which is also not a result of this PR as it's already on staging:

Screen.Recording.2023-05-10.at.15.19.09.mov

Here's what I've discovered:

The bug persists even when all updates to the component are prevented (using shouldComponentUpdate returning false).
It is not caused by the Attachment Carousel rendering or re-rendering.
It is not caused by the Attachment Carousel receiving new props (The Carousel is connected to reportActions through Onyx, but with my PR changes do not trigger a re-render).
The underlying issue is the scrollview / virtual list re-rendering, which resets the scroll position.
The cause of the scroll view re-rendering is unclear; it may be related to the scrollview being a child of another scrollview that receives an update (e.g., comment added/removed).

The reported bugs are not a result of this PR or the implemented proposal. They may stem from the app's structure or react-native-web issues. Instead of blocking the current PR, let's open separate issues to address these concerns.

sobitneupane · 2023-05-10T13:26:05Z

@kidroca I am in total agreement with you about the first issue. I will report it later in slack.

But for the second issue, PR won't pass the QA test as Test 2 is still reproducible in mWeb/Safari and mWeb/Chrome . So, we should either remove the Test 2 from Test steps or solve the issue. I kind of agree with you that it looks like a different issue. What's your opinion on this @cead22?

kidroca · 2023-05-10T15:25:45Z

@sobitneupane

But for the second issue, PR won't pass the QA test as Test 2 is still reproducible in mWeb/Safari and mWeb/Chrome . So, we should either remove the Test 2 from Test steps or solve the issue. I kind of agree with you that it looks like a different issue.

The PR successfully addresses the behavior outlined in Test 2 for all other platforms. However, there appears to be another bug specific to mWeb that is not related to the Carousel component code.

The mWeb problem seem to be deeper and requires another investigation, it could be related to this other issue, and how attachments are rendered by the ImageRenderer in the chat

[HOLD for payment 2023-07-17] [HOLD for payment 2023-07-12] [$1000] Attachment Carousel closes on its own when a specific image is deleted #18451

cead22 · 2023-05-10T17:07:49Z

I'm not sure, but what do you think about putting this on hold, until we figure out the root cause of the two other issues that surfaced when working on this one?

This is because my understanding is that the root cause outlined in the original proposal wasn't right, as @kidroca seems to have discovered the real root cause here, and I'm wondering if fixing the root cause will fix all these issues.

This PR fixes the linked issue, but that issue might just be a symptom of a bigger problem, and it also makes platforms have inconsistent behavior (ie, "The PR successfully addresses the behavior outlined in Test 2 for all other platforms", though I don't know if that's true today, or only in this PR)

kidroca · 2023-05-10T20:53:32Z

@cead22
This PR should not be delayed. We can proceed with merging it because, irrespective of the other issues' origins, the changes introduced here are essential to prevent the component from adding/removing attachments to the carousel while in use.

It was only after preventing this component from updating that we were able to uncover additional problems. While this PR may not solve the entire problem, it serves as a necessary stepping stone towards the solution.

kidroca · 2023-05-10T21:02:32Z

The inconsistency in mWeb stems from a separate bug, not from this component. The component is correctly configured to initialize and cease updating with new attachments.

As for the root cause of the newly discovered bug, I don't have a definite answer. However, I've shared my findings in a previous comment that may shed light on possible origins.

cead22 · 2023-05-10T22:44:52Z

That's fair, in that case

Can you remove the "Test 2: Removing Attachments" section from the PR description, that way it doesn't look like we're merging this with a use case not passing the tests?
Can you update the screenshots for mWeb with videos showing that Test 1 works?

kidroca · 2023-05-11T10:43:31Z

@sobitneupane @cead22
As requested, I've removed Step 2 from the test procedure.

In addition, I've done further debugging to trace the issue specific to mWeb. I discovered that something is triggering the focus event on the first attachment item (HTML div element), which results in it scrolling into view. I recommend that we create a separate task to investigate this further.

sobitneupane

Screenshots/Videos

Web

Web_1.mov

Mobile Web - Chrome

Screen.Recording.2023-05-11.at.17.45.13.mov

Mobile Web - Safari

Safari_1.mov

Desktop

Desktop.mov

iOS

IOS_1.mov

Android

Screen.Recording.2023-05-11.at.17.42.33.mov

sobitneupane

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.

OSBotify · 2023-05-11T16:10: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-05-15T09:20:29Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.14-0 🚀

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

OSBotify · 2023-05-17T00:20:19Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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

Fix: Don't add new content an already opened carousel

c87b0be

kidroca marked this pull request as ready for review May 9, 2023 17:42

kidroca requested a review from a team as a code owner May 9, 2023 17:42

melvin-bot bot requested review from cead22 and sobitneupane and removed request for a team May 9, 2023 17:43

kidroca mentioned this pull request May 9, 2023

[HOLD for payment 2023-05-23] [$1000] image changes automatic when image preview is opened and sender sends any new image #17743

Closed

6 tasks

sobitneupane reviewed May 10, 2023

View reviewed changes

sobitneupane reviewed May 11, 2023

View reviewed changes

sobitneupane approved these changes May 11, 2023

View reviewed changes

cead22 approved these changes May 11, 2023

View reviewed changes

cead22 merged commit 9fa8c89 into Expensify:main May 11, 2023

kidroca deleted the kidroca/fix/do-not-refresh-already-opened-carousel branch May 11, 2023 20:25

OSBotify mentioned this pull request May 15, 2023

Deploy Checklist: New Expensify 2023-05-15 #18938

Closed

67 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Don't add new content an already opened carousel #18651

Fix: Don't add new content an already opened carousel #18651

kidroca commented May 9, 2023 •

edited

Loading

melvin-bot bot commented May 9, 2023

sobitneupane left a comment •

edited

Loading

sobitneupane commented May 10, 2023

kidroca commented May 10, 2023 •

edited

Loading

sobitneupane commented May 10, 2023 •

edited

Loading

kidroca commented May 10, 2023

cead22 commented May 10, 2023 •

edited

Loading

kidroca commented May 10, 2023

kidroca commented May 10, 2023 •

edited

Loading

cead22 commented May 10, 2023

kidroca commented May 11, 2023 •

edited

Loading

sobitneupane left a comment

sobitneupane left a comment

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

OSBotify commented May 17, 2023

Fix: Don't add new content an already opened carousel #18651

Fix: Don't add new content an already opened carousel #18651

Conversation

kidroca commented May 9, 2023 • edited Loading

Details

Fixed Issues

Tests

Test 1: Adding Attachments

Offline tests

QA Steps

Test 1: Adding Attachments

PR Author Checklist

Screenshots/Videos

Bug no longer occurs

Removing image does not disturb carousel

melvin-bot bot commented May 9, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

sobitneupane commented May 10, 2023

kidroca commented May 10, 2023 • edited Loading

sobitneupane commented May 10, 2023 • edited Loading

kidroca commented May 10, 2023

cead22 commented May 10, 2023 • edited Loading

kidroca commented May 10, 2023

kidroca commented May 10, 2023 • edited Loading

cead22 commented May 10, 2023

kidroca commented May 11, 2023 • edited Loading

sobitneupane left a comment

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

OSBotify commented May 17, 2023

kidroca commented May 9, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading

kidroca commented May 10, 2023 •

edited

Loading

sobitneupane commented May 10, 2023 •

edited

Loading

cead22 commented May 10, 2023 •

edited

Loading

kidroca commented May 10, 2023 •

edited

Loading

kidroca commented May 11, 2023 •

edited

Loading