Update dynamically attachment modal #22543

dukenv0307 · 2023-07-10T08:44:24Z

Details

Update dynamically attachment modal

Fixed Issues

$ #21334
PROPOSAL: #21334 (comment)

Tests

The attachment modal should update dynamically if another user sends a new attachment

Login with user A
On another device, login with user B
From user B, send an attachment
From user A, click on the attachment to open attachment modal
From user B, send an attachment again
From user A, verify that the user can click on the arrow right button to see the newest attachment that is sent by user B

The attachment modal should dismiss if another user deletes the attachment that is displaying

Login with user A
On another device, login with user B
From user Bm send an attachment
From user A, click on the attachment to open attachment modal
From user B, delete this attachment
From user A, verify that attachment modal closed

Verify that no errors appear in the JS console

Offline tests

QA Steps

The attachment modal should update dynamically if another user sends a new attachment

Login with user A
On another device, login with user B
From user B, send an attachment
From user A, click on the attachment to open attachment modal
From user B, send an attachment again
From user A, verify that the user can click on the arrow right button to see the newest attachment that is sent by user B

The attachment modal should dismiss if another user deletes the attachment that is displaying

Login with user A
On another device, login with user B
From user Bm send an attachment
From user A, click on the attachment to open attachment modal
From user B, delete this attachment
From user A, verify that attachment modal closed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

The attachment modal should update dynamically if another user sends a new attachment

Screencast.from.10-07-2023.15.46.21.webm

The attachment modal should dismiss if another user deletes the attachment that is displaying

Screencast.from.10-07-2023.15.48.38.webm

Mobile Web - Chrome

The attachment modal should update dynamically if another user sends a new attachment

Record_2023-07-10-15-53-05.mp4

The attachment modal should dismiss if another user deletes the attachment that is displaying

Record_2023-07-10-15-53-33.mp4

Mobile Web - Safari

The attachment modal should update dynamically if another user sends a new attachment

safari-1.mp4

The attachment modal should dismiss if another user deletes the attachment that is displaying

safari-2.mp4

Desktop

The attachment modal should update dynamically if another user sends a new attachment

desktop-1.mp4

The attachment modal should dismiss if another user deletes the attachment that is displaying

desktop-2.mp4

iOS

The attachment modal should update dynamically if another user sends a new attachment

ios-1.mp4

The attachment modal should dismiss if another user deletes the attachment that is displaying

ios-2.mp4

Android

The attachment modal should update dynamically if another user sends a new attachment

21334-1.mp4

The attachment modal should dismiss if another user deletes the attachment that is displaying

21334-2.mp4

melvin-bot · 2023-07-11T03:31:08Z

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

narefyev91 · 2023-07-11T12:00:28Z

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

8mb.video-EhW-6bvC514d.mp4

Mobile Web - Chrome

8mb.video-lF7-znKLgFD6.mp4

Mobile Web - Safari

8mb.video-TOI-QXXyQkHZ.mp4

Desktop

8mb.video-Rcx-NO0KpwyH.mp4

iOS

8mb.video-vhR-xwaCpLo5.mp4

Android

8mb.video-dBO-FJ7wcQBn.mp4

narefyev91

LGTM
🎀 👀 🎀 C+ reviewed

dukenv0307 · 2023-07-11T17:27:34Z

@narefyev91 We have another bug when we update dynamically with this PR that I mentioned in slack thread here https://expensify.slack.com/archives/C01GTK53T8Q/p1688999272836799?thread_ts=1688646398.596839&cid=C01GTK53T8Q Can you take a look at this.

Screencast.from.10-07-2023.21_19_32.webm

jasperhuangg · 2023-07-11T18:02:26Z

@narefyev91 We have another bug when we update dynamically with this PR that I mentioned in slack thread here https://expensify.slack.com/archives/C01GTK53T8Q/p1688999272836799?thread_ts=1688646398.596839&cid=C01GTK53T8Q Can you take a look at this.

Screencast.from.10-07-2023.21_19_32.webm

@dukenv0307 does this happen when the sender is viewing the image?

dukenv0307 · 2023-07-11T18:10:10Z

@jasperhuangg This only happens when the user is viewing the first image of the report and from another device, the participant of the report add an attachment.

jasperhuangg · 2023-07-11T23:25:23Z

@dukenv0307 gotcha, then it sounds like we need to fix that before this is merged. What have you tried thus far to preserve the index of the currently displayed image?

jasperhuangg

taking away my approval since it looks like this isn't ready yet

dukenv0307 · 2023-07-11T23:54:31Z

@jasperhuangg The page state is updated correctly but when we is viewing the first image and then page state is updated, onViewableItemsChanged of FlatList is triggered, and viewableItems that is passed to update fucntion is the next image instead of the current image. It is the behavior of FlatList and I cannot find the reason and the solution for this.

narefyev91 · 2023-07-12T07:05:27Z

@jasperhuangg The page state is updated correctly but when we is viewing the first image and then page state is updated, onViewableItemsChanged of FlatList is triggered, and viewableItems that is passed to update fucntion is the next image instead of the current image. It is the behavior of FlatList and I cannot find the reason and the solution for this.

@dukenv0307 maybe you can store latest viewed page in ref and when you get updates for pages - you will check if user already seen any of the image and use that stored page index/id

dukenv0307 · 2023-07-12T07:29:40Z

@jasperhuangg The page state is updated correctly but when we is viewing the first image and then page state is updated, onViewableItemsChanged of FlatList is triggered, and viewableItems that is passed to update fucntion is the next image instead of the current image. It is the behavior of FlatList and I cannot find the reason and the solution for this.

@narefyev91 onViewableItemsChanged is auto-triggered for this case and the next image will always display even we don't update page state in update function.

narefyev91 · 2023-07-12T08:42:07Z

onViewableItemsChanged

Why does this not happened for all other platforms - but only happened for web and desktop? Also seems you should not be getting to next image if this condition will be met
const entry = _.first(viewableItems);
if (!entry) {
this.setState({activeSource: null});
return;
}

dukenv0307 · 2023-07-12T09:13:12Z

Also seems you should not be getting to next image if this condition will be met

viewableItems is passed by onViewableItemsChanged and it is the next image.

const entry = _.first(viewableItems);
if (!entry) {
this.setState({activeSource: null});
return;
}

And it is not empty.

dukenv0307 · 2023-07-12T09:31:19Z

@narefyev91 It Seems the reason is in native we revert the array and when we add new attachment, page state doesn't change.But in native, we have the same bug when we delete the previous image of the current image that we are viewing

jasperhuangg · 2023-07-12T18:58:06Z

@dukenv0307 there's no way you can store some type of index anywhere, either in this component or the a parent component, that keeps track of the currently viewed attachment?

dukenv0307 · 2023-07-13T02:38:40Z

@jasperhuangg page state stored correctly the index of the currently viewed attachment, but for this bug, it's the behavior of FlatList and we cannot control this.

jasperhuangg · 2023-07-13T21:13:46Z

@dukenv0307 what have you tried to fix this problem?

There seems to be a viewabilityConfig that we can provide to the FlatList, could anything in there help us solve this problem?

dukenv0307 · 2023-07-14T00:06:20Z

@jasperhuangg I tried to add waitForInteraction: true into viewabilityConfig and move the logic to set page state in update fucntion into cycleThroughAttachments. With this config, onViewableItemsChanged isn't triggered but this issue still occurs.

dukenv0307 · 2023-07-14T00:32:27Z

@jasperhuangg I just tried to add a callback after the update state in componentDidUpdate to scroll to current image by using ref, this bug doesn't occur but it make a werid because it move from next image to current image.

Screencast.from.14-07-2023.07.31.36.webm

dukenv0307 · 2023-07-20T02:49:30Z

@jasperhuangg Friendly bump.

dukenv0307 · 2023-07-21T02:49:23Z

@narefyev91 Please help to review this PR again.

dukenv0307 · 2023-07-24T02:34:00Z

@narefyev91 I just updated to set animatied as false when we dynamic update attachment. Please help to check again.

dukenv0307 · 2023-07-26T01:26:17Z

@narefyev91 Friendly Bump for reviewing

dukenv0307 · 2023-07-27T09:56:44Z

@jasperhuangg
narefyev91 seems to be busy, Please help me to review the PR again before he comes back.

narefyev91 · 2023-07-27T09:59:27Z

@dukenv0307 @jasperhuangg sorry guys i'm on vacation - will not be able to have one more look at it for now

dukenv0307 · 2023-07-28T07:41:55Z

merge main to update to function component

jasperhuangg

good work!

melvin-bot · 2023-07-28T19:42:32Z

@jasperhuangg looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2023-07-28T19:46:19Z

✋ 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-07-31T18:57:49Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.48-0 🚀

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

Beamanator · 2023-08-01T10:12:13Z

src/components/AttachmentCarousel/createInitialState.js

@@ -50,7 +51,7 @@ function createInitialState(props) {

    const page = _.findIndex(attachments, (a) => a.source === props.source);
    if (page === -1) {
-        throw new Error('Attachment not found');
+        Navigation.dismissModal();
    }


Do we need to return after this so that props.onNavigate doesn't still get called?

@Beamanator When we create the PR, this component is a class component and I added return here. And then after it is changed to a function component, I resolve conflict, and if we return here the function doesn't return the state and the app also crashes, So I think we should the check to prevent call props.onNavigate or check in props.onNavigate function to do nothing if the attachment is empty.

Ya looks like this is causing this regression: #23964

@Beamanator Do I need to create a PR to quickly fix it?

@dukenv0307 interesting - I did this and it seemed to work fine for me: #23988

So I returned an object, not undefined

Thanks for offering creating a PR, but I already created one 😅 ^ feel free to review if you'd like

So I returned an object, not undefined

That looks good to me.

Thanks for offering creating a PR, but I already created one sweat_smile ^ feel free to review if you'd like

Thank you.

Hey @Beamanator and @dukenv0307,

I've noticed we've opted to remove the error throw in this section. While I understand this might be an attempt to address the issue of deleting an image, we need to recall that it was previously flagged as a bug when the carousel closed upon an image deletion (Issue #18451). Reintroducing this behavior might not be the best move.

The original intent of the createInitialState—as the name suggests—was to execute just once upon the carousel's opening. Its purpose was to display the "Ooops" screen if a user tries to open an unlocatable attachment. In my opinion, presenting this error screen offers a more insightful user experience compared to abruptly closing the modal, which may come off as if the user's action was disregarded.

Can we reconsider this change and perhaps retain the error throw?

OSBotify · 2023-08-01T23:59:06Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.48-5 🚀

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

OSBotify · 2023-08-02T01:23:36Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.49-0 🚀

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

OSBotify · 2023-08-03T18:16:03Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀

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

dukenv0307 added 3 commits July 10, 2023 12:30

update attachment modal dynamically

f83a9b3

refactor condition

4dd20d4

fix/21334

0aa8469

dukenv0307 marked this pull request as ready for review July 11, 2023 03:31

dukenv0307 requested a review from a team as a code owner July 11, 2023 03:31

melvin-bot bot requested review from narefyev91 and removed request for a team July 11, 2023 03:31

narefyev91 approved these changes Jul 11, 2023

View reviewed changes

melvin-bot bot requested a review from jasperhuangg July 11, 2023 17:20

jasperhuangg approved these changes Jul 11, 2023

View reviewed changes

jasperhuangg self-requested a review July 11, 2023 23:25

jasperhuangg requested changes Jul 11, 2023

View reviewed changes

Merge branch 'main' into fix/21334

32c3eb7

dukenv0307 added 2 commits July 19, 2023 10:16

return when dissmiss the modal

402f106

fix prettier

0109bb3

jasperhuangg requested a review from narefyev91 July 20, 2023 17:25

aviod animated in native when dynamic update

acf0547

remove comment line

cda6d8d

merge main

570047c

jasperhuangg approved these changes Jul 28, 2023

View reviewed changes

jasperhuangg merged commit 0c4bcd1 into Expensify:main Jul 28, 2023

melvin-bot bot added the Emergency label Jul 28, 2023

OSBotify mentioned this pull request Jul 31, 2023

Deploy Checklist: New Expensify 2023-07-31 #23945

Closed

48 tasks

lanitochka17 mentioned this pull request Jul 31, 2023

[HOLD for payment 2023-08-10] [HOLD for payment 2023-08-08] Chat - Crash when deleting attachment from user B when user A has open attachment modal #23964

Closed

6 tasks

Beamanator reviewed Aug 1, 2023

View reviewed changes

Beamanator mentioned this pull request Aug 1, 2023

[CP Staging] Return early when dismissing modal so we don't call onNavigate with no attachments #23988

Merged

58 tasks

OSBotify mentioned this pull request Aug 1, 2023

Deploy Checklist: New Expensify 2023-08-01 #24028

Closed

79 tasks

melvin-bot bot mentioned this pull request Aug 1, 2023

[HOLD for payment 2023-08-08] [$1000] Attachment preview does not update dynamically #21334

Closed

6 tasks

fedirjh mentioned this pull request Aug 9, 2023

Migrate AttachmentCarousel/index.js to function component #23072

Merged

58 tasks

Update dynamically attachment modal #22543

Update dynamically attachment modal #22543

Conversation

dukenv0307 commented Jul 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 11, 2023

narefyev91 commented Jul 11, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

narefyev91 left a comment

Choose a reason for hiding this comment

dukenv0307 commented Jul 11, 2023 • edited Loading

jasperhuangg commented Jul 11, 2023

dukenv0307 commented Jul 11, 2023 • edited Loading

jasperhuangg commented Jul 11, 2023

jasperhuangg left a comment

Choose a reason for hiding this comment

dukenv0307 commented Jul 11, 2023 • edited Loading

narefyev91 commented Jul 12, 2023

dukenv0307 commented Jul 12, 2023

narefyev91 commented Jul 12, 2023

dukenv0307 commented Jul 12, 2023 • edited Loading

dukenv0307 commented Jul 12, 2023 • edited Loading

jasperhuangg commented Jul 12, 2023

dukenv0307 commented Jul 13, 2023

jasperhuangg commented Jul 13, 2023

dukenv0307 commented Jul 14, 2023

dukenv0307 commented Jul 14, 2023

dukenv0307 commented Jul 20, 2023

dukenv0307 commented Jul 21, 2023

dukenv0307 commented Jul 24, 2023

dukenv0307 commented Jul 26, 2023

dukenv0307 commented Jul 27, 2023 • edited Loading

narefyev91 commented Jul 27, 2023

dukenv0307 commented Jul 28, 2023

jasperhuangg left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 28, 2023

OSBotify commented Jul 28, 2023

OSBotify commented Jul 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Aug 1, 2023

OSBotify commented Aug 2, 2023

OSBotify commented Aug 3, 2023

dukenv0307 commented Jul 10, 2023 •

edited

Loading

narefyev91 commented Jul 11, 2023 •

edited

Loading

dukenv0307 commented Jul 11, 2023 •

edited

Loading

dukenv0307 commented Jul 11, 2023 •

edited

Loading

dukenv0307 commented Jul 11, 2023 •

edited

Loading

dukenv0307 commented Jul 12, 2023 •

edited

Loading

dukenv0307 commented Jul 12, 2023 •

edited

Loading

dukenv0307 commented Jul 27, 2023 •

edited

Loading