Fix 22306 web appropriate message is not shown when drag drop a folder #23321

Charan-hs · 2023-07-21T01:30:23Z

Details

Fixed Issues

$ #22306
PROPOSAL: #22306 (comment)

Tests

Open Any Chat.
Drag and Drop a Folder on the Chat window.
An Error message of Uploading a folder is not allowed. Try a different file. shown.

Verify that no errors appear in the JS console

Offline tests

same as above

QA Steps

same as above

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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

Safari

Safari-Folder-1.mov

Chrome

Chrome-folder-1.mov

Uploading file without type property

safari-fileWithoutType-1.mov

Mobile Web - Chrome

mobile.chrome.test.comp.mp4

Mobile Web - Safari

ios.mobile.safari.comp.mp4

Desktop

desktop.rec.comp.mp4

iOS

ios.app.comp.mp4

Android

android.app.com.test.mp4

github-actions · 2023-07-21T01:30:42Z

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

Charan-hs · 2023-07-21T01:33:37Z

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

Charan-hs · 2023-07-21T01:34:05Z

recheck

Charan-hs · 2023-07-21T01:55:03Z

@abdulrahuman5196 we can modify the Error Title and message Based on your need.

melvin-bot · 2023-07-21T02:01:19Z

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

abdulrahuman5196 · 2023-07-23T12:45:25Z

src/components/AttachmentModal.js

     * @returns {Boolean}
     */
    const isValidFile = useCallback(
-        (_file) => {
+        (_file,_data) => {


Why do we need both file and data? _data.getAsFile provides the file right?

yeah, but this function is also used in the file picker addition to drag and drop, so there you won't get data files but normal file objects. Added this condition will resolve even if a user is uploading on different platforms it won't have an effect.
we can remove _data props but we should add this check or we can create a function which do the same.

let _file = _data if (typeof _data.getAsFile === 'function' ){ _file = _data.getAsFile(); }

so what's your suggestion?

My concern is we are literally passing a superset data(which could also has file). But you are saying in file picker we won't get this data, only file value.
I think we can replace there as well. But i don't think it worth that change.

Then maybe before coming to function itself can we do a early return if the data is a directory and display appropriate error here itself

if (typeof _data.getAsFile === 'function' ){ _file = _data.getAsFile(); }

This will also provide segregated code check for directory and file check.

We can maybe create a function isDirectory and use it on the above which will be much cleaner.

@Charan-hs

@abdulrahuman5196

/** * @param {Object} _data * @returns {Object} */ const isDirectoryCheckAndGetFile = useCallback((_data) => { if (typeof _data.webkitGetAsEntry === 'function' && _data.webkitGetAsEntry().isDirectory) { setIsAttachmentInvalid(true); setAttachmentInvalidReasonTitle(props.translate('attachmentPicker.attachmentError')); setAttachmentInvalidReason(props.translate('attachmentPicker.folderNotAllowedMessage')); return null; } if (typeof _data.getAsFile === 'function' ){ return _data.getAsFile(); } return _data },[props.translate]) const validateAndDisplayFileToUpload = ...(_data) => { const _file = isDirectoryCheckAndGetFile(_data) if(!_file){ return } .... }...

what about this approach?

IMO, IsDirectorycheck and getFile is different functionality. So IsDirectorycheck is fine and getFile can stay in current validateAndDisplayFileToUpload place

abdulrahuman5196 · 2023-07-25T17:24:31Z

recheck

abdulrahuman5196 · 2023-07-25T17:25:27Z

@luacmartins If possible could you start the workflow steps to avoid lint failures after testing?

luacmartins · 2023-07-25T17:30:39Z

done

abdulrahuman5196 · 2023-07-25T17:34:57Z

src/languages/en.js

@@ -168,6 +168,7 @@ export default {
        sizeNotMet: 'Attachment size must be greater than 240 bytes.',
        wrongFileType: 'Attachment is the wrong type',
        notAllowedExtension: 'This filetype is not allowed',
+        folderNotAllowedMessage: 'Uploading folder is not allowed.'


@luacmartins Sorry to bother again.
Whom should we confirm the error message with? In most cases previously internal engineers would provide the required string AFAIK.

@luacmartins Gentle ping on this confirmation

@abdulrahuman5196 thanks for the ping, I missed the first one 😬 I added the Waiting for copy label in the issue to get someone to review the copy. Let's see what they say.

@Charan-hs @abdulrahuman5196 the updated copy is: Uploading a folder is not allowed. Try a different file.

abdulrahuman5196 · 2023-07-25T17:39:46Z

@Charan-hs lint and signed commits are failing, kindly fix the same(I suspected lint to fail, that's why requested to run checks).

Since you are a first time contributor just providing some information - PR Reviewer Checklist would be fixed after my review. Other checks should be fixed before that.

Charan-hs · 2023-07-25T19:06:46Z

@abdulrahuman5196

all Commits are Signed and resolved lint issues.

Charan-hs · 2023-07-26T19:00:33Z

recheck

abdulrahuman5196 · 2023-07-26T19:40:18Z

src/components/AttachmentModal.js

+            if (!isDirectoryCheck(_data)) {
+                return;
+            }
+            /* eslint no-underscore-dangle: 0 */


Why do we need to want to disable a lint rule here? Can we just rename the variable @Charan-hs ?

Just to stay with the previous file name so. can I change that to fileObject @abdulrahuman5196 ?

abdulrahuman5196 · 2023-08-03T07:56:57Z

@Charan-hs Can we also check and fix the merge conflicts?

…wn_when_drag_drop_a_folder

…is_not_shown_when_drag_drop_a_folder

abdulrahuman5196 · 2023-08-03T12:37:08Z

@Charan-hs Is the changes complete from your end?

abdulrahuman5196 · 2023-08-03T12:43:28Z

@luacmartins I already tested previously all the changes before merge conflict and it was working fine. Can we re-run the workflow checks? If its working I can do a quick test again and we can merge.

Charan-hs · 2023-08-03T13:05:22Z

@Charan-hs Is the changes complete from your end?

yes, All Good @abdulrahuman5196

luacmartins · 2023-08-03T15:52:59Z

@abdulrahuman5196 kicked off the workflow checks

abdulrahuman5196 · 2023-08-03T15:56:46Z

@Charan-hs Lint code is failing. Could you kindly check on the same?

luacmartins · 2023-08-03T15:58:14Z

@Charan-hs lint is failing!

Charan-hs · 2023-08-03T16:00:05Z

resolved Lint Issue,

luacmartins · 2023-08-03T16:21:36Z

All checks are passing now! @abdulrahuman5196 wanna do a final check before we merge?

abdulrahuman5196 · 2023-08-03T16:25:17Z

Yes. Working on it

abdulrahuman5196 · 2023-08-03T16:35:12Z

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-08-02.at.1.22.47.PM.mp4

Mobile Web - Chrome

az_recorder_20230802_134344.mp4

Mobile Web - Safari

Untitled.1.mp4

Desktop

Screen.Recording.2023-08-02.at.1.34.47.PM.mp4

iOS

Screen.Recording.2023-08-02.at.1.36.20.PM.mp4

Android

Screen.Recording.2023-08-02.at.1.38.29.PM.mp4

Screen.Recording.2023-08-02.at.1.40.16.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @luacmartins Good to merge

🎀 👀 🎀
C+ Reviewed

abdulrahuman5196 · 2023-08-03T16:40:14Z

Just to note: I was seeing issue where the error message was not dynamically changed on language changes from other devices. But I am able to see the same issue in main as well. So Will raise a separate bug on the same.

OSBotify · 2023-08-03T16:44:47Z

✋ 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-08-03T17:40:46Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.50-0 🚀

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

OSBotify · 2023-08-07T18:29:06Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

OSBotify · 2023-08-07T18:56:16Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.51-0 🚀

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

OSBotify · 2023-08-09T08:45:24Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

Charan-hs marked this pull request as ready for review July 21, 2023 02:01

Charan-hs requested a review from a team as a code owner July 21, 2023 02:01

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team July 21, 2023 02:01

Charan-hs mentioned this pull request Jul 21, 2023

[HOLD for payment 2023-08-14] [$1000] Web - Appropriate message is not shown when drag&drop a folder. #22306

Closed

6 tasks

abdulrahuman5196 reviewed Jul 23, 2023

View reviewed changes

Charan-hs requested a review from abdulrahuman5196 July 24, 2023 19:13

abdulrahuman5196 reviewed Jul 25, 2023

View reviewed changes

Webkitdirectory added

b7cda7b

Charan-hs force-pushed the Fix_22306_Web_Appropriate_message_is_not_shown_when_drag_drop_a_folder branch from 11c23f7 to 29df310 Compare July 25, 2023 18:51

Charan-hs added 6 commits July 26, 2023 00:25

checking file is a folder

d841c88

update error message

319006f

checking file is data object

f02b0ca

isDirectoryCheck added

c2c30d2

prettier changes

4e8b68d

lint issue resloved

ff278da

Charan-hs force-pushed the Fix_22306_Web_Appropriate_message_is_not_shown_when_drag_drop_a_folder branch from 29df310 to ff278da Compare July 25, 2023 18:57

Charan-hs requested a review from abdulrahuman5196 July 25, 2023 19:20

abdulrahuman5196 reviewed Jul 26, 2023

View reviewed changes

Charan-hs added 2 commits August 3, 2023 15:29

Merge branch 'main' into Fix_22306_Web_Appropriate_message_is_not_sho…

7f73906

…wn_when_drag_drop_a_folder

Merge branch 'main' into Fix_22306_Web_Appropriate_message_is_not_sho…

cab4ae6

…wn_when_drag_drop_a_folder

Charan-hs dismissed luacmartins’s stale review via cab4ae6 August 3, 2023 10:20

Charan-hs and others added 2 commits August 3, 2023 16:02

Merge branch 'Expensify:main' into Fix_22306_Web_Appropriate_message_…

54a3829

…is_not_shown_when_drag_drop_a_folder

propsTranslate to localize Translate

216f5e7

removed unnecessary translate dep

2bc09e0

prettier

f137541

abdulrahuman5196 approved these changes Aug 3, 2023

View reviewed changes

melvin-bot bot requested a review from luacmartins August 3, 2023 16:38

luacmartins approved these changes Aug 3, 2023

View reviewed changes

luacmartins merged commit d9c2897 into Expensify:main Aug 3, 2023
17 of 19 checks passed

OSBotify mentioned this pull request Aug 3, 2023

Deploy Checklist: New Expensify 2023-08-03 #24121

Closed

86 tasks

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

Fix 22306 web appropriate message is not shown when drag drop a folder #23321

Fix 22306 web appropriate message is not shown when drag drop a folder #23321

Conversation

Charan-hs commented Jul 21, 2023 • edited by luacmartins Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jul 21, 2023 • edited Loading

Charan-hs commented Jul 21, 2023

Charan-hs commented Jul 21, 2023

Charan-hs commented Jul 21, 2023

melvin-bot bot commented Jul 21, 2023

Choose a reason for hiding this comment

Charan-hs Jul 23, 2023 • edited Loading

Choose a reason for hiding this comment

abdulrahuman5196 Jul 24, 2023 • edited Loading

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

abdulrahuman5196 commented Jul 25, 2023

abdulrahuman5196 commented Jul 25, 2023

luacmartins commented Jul 25, 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

abdulrahuman5196 commented Jul 25, 2023

Charan-hs commented Jul 25, 2023

Charan-hs commented Jul 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

Charan-hs commented Aug 3, 2023

luacmartins commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

luacmartins commented Aug 3, 2023

Charan-hs commented Aug 3, 2023

luacmartins commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Aug 3, 2023 • edited Loading

OSBotify commented Aug 3, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

Charan-hs commented Jul 21, 2023 •

edited by luacmartins

Loading

github-actions bot commented Jul 21, 2023 •

edited

Loading

Charan-hs Jul 23, 2023 •

edited

Loading

abdulrahuman5196 Jul 24, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 3, 2023 •

edited

Loading