Improve Attachment Carousel State Management in AttachmentModal and ReportAttachments #22179

kidroca · 2023-07-04T14:16:32Z

Details

Added a new optional callback onCarouselAttachmentChange prop to the AttachmentModal component. This prop is a function that gets called whenever the carousel attachment changes, providing the current attachment object as an argument. This change will ensure the correct state is maintained for the modal during the interaction with the carousel.
Updated the onNavigate function in the AttachmentModal component. This function is now responsible for setting the state of isAuthTokenRequired, which can change depending on the current attachment.
Added a corresponding function to the ReportAttachments page that utilizes the onCarouselAttachmentChange callback. This function navigates to the respective route for each attachment when the carousel attachment changes.

Fixed Issues

$ #18451
PROPOSAL: #18451 (comment)

$ #22133
PROPOSAL: #22133 (comment)

Tests

On web and mobile web

Verify the URL in the address bar of the browser changes as we change attachments in the attachment carousel
Download a variety of attachments and check that the downloading functionality remains intact.
- Change attachments using the arrow and verify downloading works

Other platforms

Download a variety of attachments and check that the downloading functionality remains intact.
- Change attachments using the arrow and verify downloading works

Offline tests

N/A

Opening an attachment while offline should have the same behavior as it did before - the attachment appears to load indefinitely. We can close the attachment view and return to the chat.

QA Steps

On web and mobile web

Verify the URL in the address bar of the browser changes as we change attachments in the attachment carousel
Download a variety of attachments and check that the downloading functionality remains intact.
- Change attachments using the arrow and verify downloading works

Other platforms

Download a variety of attachments and check that the downloading functionality remains intact.
- Change attachments using the arrow and verify downloading works

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

#22179 "Mobile Web - Chrome & Mobile Web - Safari"

(from this comment: #22179 (comment))

Mobile Web - Safari

mobile.Safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

https://github.com/Expensify/App/pull/22179#:~:text=Screen.Recording.2023%2D07%2D07.at.3.04.19.AM.mov-,ios%20%26%20android,-Screen.Recording.2023%2D07%2D07.at.3.02.07.AM.mov "iOS & Android" (from this comment: #22179 (comment))

- Added a new prop `onCarouselAttachmentChange` to `AttachmentModal` component that is called whenever the carousel attachment changes. - This new prop is a function that is called with the current attachment object as its argument. - Also, a corresponding function is passed in `ReportAttachments` to navigate to the respective route for each attachment whenever the carousel attachment changes.

Details: - Modified the `onNavigate` function in `AttachmentModal` component to set the state of `isAuthTokenRequired` depending on the attachment navigated to. - This change allows the component to correctly update whether an auth token is required or not for each attachment in the carousel.

melvin-bot · 2023-07-04T14:52:38Z

@Santhosh-Sellavel 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 · 2023-07-04T14:57:53Z

This Pull Request is now ready for review ✅

I regret to inform you that I'm currently traveling and will not have access to my Desktop until next week, thereby hindering my ability to test and record videos on Android.

Given the circumstances, if it's amenable to you, I would greatly appreciate the use of any test videos you might generate during the review process. I would then incorporate them to update the PR description accordingly. Thank you for your understanding.

kidroca · 2023-07-04T15:00:04Z

Note

This PR incorporates 2 small changes as noted by the description:

A continuation to close [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 as noted in the following comment: [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 (comment)
A fix for the download issue found here: [HOLD for payment 2023-07-17] [$1000] Web - User is unable to download attachment #22133

Julesssss · 2023-07-04T15:25:53Z

Lets assign @allroundexperts once it's ready for review

kidroca · 2023-07-04T19:53:03Z

Lets assign @allroundexperts once it's ready for review

The PR is ready for review with the android caveat mentioned here: #22179 (comment)

src/components/AttachmentModal.js

Julesssss · 2023-07-05T08:09:41Z

Reassigned @Santhosh-Sellavel for review

Santhosh-Sellavel · 2023-07-05T22:41:20Z

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 & Desktop

Screen.Recording.2023-07-07.at.3.00.13.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-07-07.at.3.04.19.AM.mov

iOS & Android

Screen.Recording.2023-07-07.at.3.02.07.AM.mov

Santhosh-Sellavel · 2023-07-05T22:42:39Z

Tested web alone works well so far, will continue and complete the reviewer checklist tomorrow!

Santhosh-Sellavel

LGTM tests well!

All yours @Julesssss!

Santhosh-Sellavel · 2023-07-06T21:44:22Z

@kidroca Please complete the author checklist, my recording should be enough here, thanks!

OSBotify · 2023-07-07T08:56: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-07T10:43:48Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.38-0 🚀

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

OSBotify · 2023-07-10T23:58:50Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

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

kidroca added 2 commits July 4, 2023 15:55

kidroca mentioned this pull request Jul 4, 2023

[HOLD for payment 2023-07-17] [$1000] Web - User is unable to download attachment #22133

Closed

6 tasks

Code style: reformat with prettier

806734f

Julesssss assigned kidroca Jul 4, 2023

Julesssss requested a review from Santhosh-Sellavel July 4, 2023 14:42

kidroca marked this pull request as ready for review July 4, 2023 14:52

kidroca requested a review from a team as a code owner July 4, 2023 14:52

melvin-bot bot removed the request for review from a team July 4, 2023 14:52

Julesssss removed the request for review from Santhosh-Sellavel July 4, 2023 15:24

Julesssss requested a review from allroundexperts July 5, 2023 08:05

Julesssss reviewed Jul 5, 2023

View reviewed changes

src/components/AttachmentModal.js Show resolved Hide resolved

Julesssss requested review from Santhosh-Sellavel and removed request for allroundexperts July 5, 2023 08:09

Santhosh-Sellavel approved these changes Jul 6, 2023

View reviewed changes

melvin-bot bot requested a review from Julesssss July 6, 2023 21:42

Julesssss approved these changes Jul 7, 2023

View reviewed changes

Julesssss merged commit 776ea5d into Expensify:main Jul 7, 2023

OSBotify mentioned this pull request Jul 7, 2023

Deploy Checklist: New Expensify 2023-07-07 #22399

Closed

64 tasks

melvin-bot bot mentioned this pull request Jul 10, 2023

[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

Closed

6 tasks

kidroca deleted the kidroca/feat/attachment-modal-url branch July 12, 2023 14:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Attachment Carousel State Management in AttachmentModal and ReportAttachments #22179

Improve Attachment Carousel State Management in AttachmentModal and ReportAttachments #22179

kidroca commented Jul 4, 2023 •

edited

Loading

melvin-bot bot commented Jul 4, 2023

kidroca commented Jul 4, 2023

kidroca commented Jul 4, 2023

Julesssss commented Jul 4, 2023

kidroca commented Jul 4, 2023

Julesssss commented Jul 5, 2023

Santhosh-Sellavel commented Jul 5, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 5, 2023

Santhosh-Sellavel left a comment

Santhosh-Sellavel commented Jul 6, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 10, 2023

Improve Attachment Carousel State Management in AttachmentModal and ReportAttachments #22179

Improve Attachment Carousel State Management in AttachmentModal and ReportAttachments #22179

Conversation

kidroca commented Jul 4, 2023 • edited Loading

Details

Fixed Issues

Tests

On web and mobile web

Other platforms

Offline tests

QA Steps

On web and mobile web

Other platforms

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 4, 2023

kidroca commented Jul 4, 2023

kidroca commented Jul 4, 2023

Note

Julesssss commented Jul 4, 2023

kidroca commented Jul 4, 2023

Julesssss commented Jul 5, 2023

Santhosh-Sellavel commented Jul 5, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel commented Jul 5, 2023

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Jul 6, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 7, 2023

OSBotify commented Jul 10, 2023

kidroca commented Jul 4, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 5, 2023 •

edited

Loading