Refactor AttachmentModal to function component #20365

rayane-djouah · 2023-06-07T14:00:34Z

Details

Fixed Issues

$ #16114
PROPOSAL: #16114 (comment)

Tests

Open a chat
Upload an Attachment via button or via drag and drop
Verify that a modal appears displaying a preview of the file
Click send and verify that the file is sent successfully in the discussion

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open a chat
Upload an Attachment via button or via drag and drop
Verify that a modal appears displaying a preview of the file
Click send and verify that the file is sent successfully in the discussion

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

attachement_modal.mp4

Mobile Web - Chrome

chrome.mp4

Mobile Web - Safari

safari.mp4

Desktop

mac.mp4

iOS

ios.mp4

Android

android.mp4

melvin-bot · 2023-06-07T14:00:42Z

@marcochavezf @rushatgabhane 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]

github-actions · 2023-06-07T14:00:53Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

rayane-djouah · 2023-06-07T14:02:52Z

I have read the CLA Document and I hereby sign the CLA

rayane-djouah · 2023-06-09T14:23:00Z

@marcochavezf @rushatgabhane please review this PR

marcochavezf · 2023-06-09T21:42:10Z

Hi @rayane-djouah thank you for the bumps. @rushatgabhane (Contributor+ team member) will review the PR first🙂

allroundexperts · 2023-06-11T21:38:20Z

@marcochavezf Can you please assign this to me as @rushatgabhane has too much on his plate ATM?

rushatgabhane · 2023-06-11T21:38:44Z

Thanks @allroundexperts!

marcochavezf · 2023-06-12T21:44:36Z

@marcochavezf Can you please assign this to me as @rushatgabhane has too much on his plate ATM?

Sure!

src/components/AttachmentModal.js

allroundexperts · 2023-06-12T23:15:38Z

@rayane-djouah Can you please upload screen recordings on all platforms?

allroundexperts · 2023-06-12T23:22:29Z

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

Screen.Recording.2023-06-13.at.4.08.30.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-06-13.at.4.13.02.AM.mov

Mobile Web - Safari

Screen.Recording.2023-06-13.at.4.10.26.AM.mov

Desktop

Screen.Recording.2023-06-13.at.4.09.39.AM.mov

iOS

Screen.Recording.2023-06-13.at.4.12.10.AM.mov

Android

Screen.Recording.2023-06-13.at.4.13.58.AM.mov

allroundexperts · 2023-06-12T23:23:59Z

@rayane-djouah Can you please also change your commit messages so that they are more meaningful? Messages like fix make the commit history really hard to read / understand.

allroundexperts · 2023-06-14T12:46:55Z

@rayane-djouah The screen recordings are still missing. Can you please add them?

rayane-djouah · 2023-06-15T18:32:27Z

@allroundexperts I added the screen recordings. can you please review?

allroundexperts

LGTM!
cc @marcochavezf

rayane-djouah · 2023-06-16T18:42:58Z

@marcochavezf PR ready for merge.

rayane-djouah · 2023-06-19T19:07:46Z

@marcochavezf

rayane-djouah · 2023-06-20T15:42:41Z

@marcochavezf please review this PR

marcochavezf

Thanks @rayane-djouah! LGTM

OSBotify · 2023-06-20T19:03:44Z

✋ 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-06-21T02:26:22Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.30-0 🚀

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

OSBotify · 2023-06-22T16:54:00Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.30-5 🚀

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

kidroca · 2023-07-04T13:43:39Z

src/components/AttachmentModal.js

-    onNavigate(attachment) {
-        this.setState(attachment);
-    }
+    const onNavigate = useCallback((attachment) => {
+        setSource(attachment.source);
+        setFile(attachment.file);
+    }, []);


@Julesssss
This is the change that caused #22133

Previously this.setState(attachment) saved source, file and isAuthTokenRequired to state
Now isAuthTokenRequired is no longer set
The flag isAuthTokenRequired is used in the download logic to create the URL needed for downloading attachments

To fix the issue we'd need to also update the isAuthTokenRequired like so:

const onNavigate = useCallback((attachment) => { setSource(attachment.source); setFile(attachment.file); setIsAuthTokenRequired(attachment.isAuthTokenRequired); }, []);

@kidroca I think this might not be correct. We tested the downloads before merging this PR. Please check this video.

Thank you for your input, @allroundexperts. I appreciate your vigilance and the tests you performed before merging the PR. However, I'd like to highlight the way fileDownload operates. It relies heavily on the isAuthTokenRequired as detailed in my comment #22133 (comment)

It's plausible that during the tests, downloading the initial image worked as expected, which could be misleading. The issue arises when attempting to download any subsequent image after scrolling through the carousel. This is due to the isAuthTokenRequired state not updating accordingly.

Moreover, with the transition of the carousel to its own route, the onNavigate function gets invoked immediately to set the initial state for the modal, further highlighting the need for an updated isAuthTokenRequired state. I hope this clarification helps!

That does make sense. This is a clear oversight. However, it might be worth checking what actually caused the issue since this was merged 3 weeks ago and we tested the downloads again with this PR which got merged 4 days ago 🤔

I'll try to pinpoint the exact change which caused this. We would surely want to fix this as well though.

Pull Request #20167, which moved the carousel, depended on the proper functioning of the onNavigate function. This function is invoked when the carousel mounts and sets the correct value of isAuthTokenRequired. While we diligently resolved several merge conflicts when syncing main with #20167, it's conceivable that this particular modification related to isAuthTokenRequired may have been overlooked. Notably, this PR had received approval a while back, but the merging process was delayed due to a code freeze, which could have further contributed to the oversight.

Yea, that makes sense. I reverted back to 50c16acc83 and it seemed to work fine. Now we have a clearer picture. Thanks @kidroca!

situchan · 2023-11-22T13:05:37Z

src/components/AttachmentModal.js

-            modalType: CONST.MODAL.MODAL_TYPE.CENTERED_UNSWIPEABLE,
-            isConfirmButtonDisabled: false,
-            confirmButtonFadeAnimation: new Animated.Value(1),
-            file: props.originalFileName


Coming from #28036:
We could have updated file state value whenever originalFileName prop changes in useEffect.

The root cause is here

rayane-djouah requested a review from a team as a code owner June 7, 2023 14:00

melvin-bot bot requested review from marcochavezf and rushatgabhane and removed request for a team June 7, 2023 14:00

rayane-djouah force-pushed the migrate-attachment-modal-to-function-component branch from fd6026f to dda2164 Compare June 8, 2023 16:57

rayane-djouah mentioned this pull request Jun 9, 2023

[HOLD for payment 2023-06-29] [$250] Migrate AttachmentModal.js to function component #16114

Closed

1 task

marcochavezf requested review from allroundexperts and removed request for rushatgabhane June 12, 2023 21:44

allroundexperts reviewed Jun 12, 2023

View reviewed changes

src/components/AttachmentModal.js Show resolved Hide resolved

allroundexperts reviewed Jun 12, 2023

View reviewed changes

src/components/AttachmentModal.js Outdated Show resolved Hide resolved

rayane-djouah force-pushed the migrate-attachment-modal-to-function-component branch 4 times, most recently from d4c51ce to b982e8a Compare June 13, 2023 23:13

rayane-djouah requested a review from allroundexperts June 14, 2023 12:45

rayane-djouah force-pushed the migrate-attachment-modal-to-function-component branch from b982e8a to 66cb6c3 Compare June 14, 2023 18:57

allroundexperts approved these changes Jun 15, 2023

View reviewed changes

Refactor AttachmentModal to function component

7caaad3

rayane-djouah force-pushed the migrate-attachment-modal-to-function-component branch from 66cb6c3 to 7caaad3 Compare June 16, 2023 12:55

marcochavezf approved these changes Jun 20, 2023

View reviewed changes

marcochavezf merged commit 6138bec into Expensify:main Jun 20, 2023

OSBotify mentioned this pull request Jun 21, 2023

Deploy Checklist: New Expensify 2023-06-21 #21172

Closed

67 tasks

kidroca reviewed Jul 4, 2023

View reviewed changes

Santhosh-Sellavel mentioned this pull request Jul 20, 2023

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

Closed

6 tasks

rayane-djouah deleted the migrate-attachment-modal-to-function-component branch September 4, 2023 12:33

situchan reviewed Nov 22, 2023

View reviewed changes

situchan mentioned this pull request Nov 22, 2023

[HOLD for payment 2023-11-06] [$1000] Web - Profile - Atachment clip icon is displayed instead of spinner when avatar is loading #28036

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor AttachmentModal to function component #20365

Refactor AttachmentModal to function component #20365

rayane-djouah commented Jun 7, 2023 •

edited

Loading

melvin-bot bot commented Jun 7, 2023

github-actions bot commented Jun 7, 2023 •

edited

Loading

rayane-djouah commented Jun 7, 2023

rayane-djouah commented Jun 9, 2023

marcochavezf commented Jun 9, 2023

allroundexperts commented Jun 11, 2023

rushatgabhane commented Jun 11, 2023

marcochavezf commented Jun 12, 2023

allroundexperts commented Jun 12, 2023

allroundexperts commented Jun 12, 2023 •

edited

Loading

allroundexperts commented Jun 12, 2023

allroundexperts commented Jun 14, 2023

rayane-djouah commented Jun 15, 2023

allroundexperts left a comment

rayane-djouah commented Jun 16, 2023

rayane-djouah commented Jun 19, 2023

rayane-djouah commented Jun 20, 2023

marcochavezf left a comment

OSBotify commented Jun 20, 2023

OSBotify commented Jun 21, 2023

OSBotify commented Jun 22, 2023

kidroca Jul 4, 2023

allroundexperts Jul 4, 2023

kidroca Jul 4, 2023

allroundexperts Jul 4, 2023

allroundexperts Jul 4, 2023

kidroca Jul 4, 2023

allroundexperts Jul 4, 2023

situchan Nov 22, 2023

situchan Nov 22, 2023

Refactor AttachmentModal to function component #20365

Refactor AttachmentModal to function component #20365

Conversation

rayane-djouah commented Jun 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 7, 2023

github-actions bot commented Jun 7, 2023 • edited Loading

rayane-djouah commented Jun 7, 2023

rayane-djouah commented Jun 9, 2023

marcochavezf commented Jun 9, 2023

allroundexperts commented Jun 11, 2023

rushatgabhane commented Jun 11, 2023

marcochavezf commented Jun 12, 2023

allroundexperts commented Jun 12, 2023

allroundexperts commented Jun 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts commented Jun 12, 2023

allroundexperts commented Jun 14, 2023

rayane-djouah commented Jun 15, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

rayane-djouah commented Jun 16, 2023

rayane-djouah commented Jun 19, 2023

rayane-djouah commented Jun 20, 2023

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 20, 2023

OSBotify commented Jun 21, 2023

OSBotify commented Jun 22, 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

Choose a reason for hiding this comment

rayane-djouah commented Jun 7, 2023 •

edited

Loading

github-actions bot commented Jun 7, 2023 •

edited

Loading

allroundexperts commented Jun 12, 2023 •

edited

Loading