Replace file names with underscore when they have slash `/` #14664

akshayasalvi · 2023-01-30T20:12:04Z

Details

Our file uploads, have issues when we have / or :, because these characters were stripped and the files are saved with .png, etc. types

Fixed Issues

$ #14266
PROPOSAL: #14266 (comment)

Tests

Have an image/file with the name as : or / with the extension, for example, /.png.
Go to any chat and upload the attachment
Select the file from point 1, and the preview should show the : and / replaced with _
Click on upload and ensure the file is successfully uploaded
Select the same file and click on the download icon
Ensure the file is successfully saved and you're able to preview.
If the file has more than one :, /, characters, it should replace with the equal number of underscores(_) in the filename.

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Have an image/file with the name as : or / with the extension, for example, /.png.
Go to any chat and upload the attachment
Select the file from point 1, and the preview should show the : and / replaced with _
Click on upload and ensure the file is successfully uploaded
Select the same file and click on the download icon
Ensure the file is successfully saved and you're able to preview.
If the file has more than one :, /, characters, it should replace with the equal number of underscores(_) in the filename.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

screen-recording-2023-01-30-at-114858-pm_aqjpeCtC.mp4

Mobile Web - Chrome

Screen.Recording.2023-01-31.at.1.19.45.AM.mov

Mobile Web - Safari

screen-recording-2023-01-31-at-125458-am_4cWC02fr.mp4

Desktop

screen-recording-2023-01-30-at-115256-pm_w55iSb78.mp4

iOS

screen-recording-2023-01-31-at-124421-am_cVByvJPq.mp4

Android

Screen.Recording.2023-01-31.at.1.20.49.AM.mov

…le-name-with-underscore

melvin-bot · 2023-01-30T20:12:11Z

@dangrous @mananjadhav 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]

akshayasalvi · 2023-01-30T20:16:08Z

@dangrous @mananjadhav I tried hard but I don't think Android allows : and / in the file name. I tried downloading a new file, renaming the file locally hence I've just tested with an current test image.

dangrous · 2023-01-30T21:14:19Z

src/libs/fileDownload/FileUtils.js

+ * @returns {String}
+ */
+function cleanFileName(fileName) {
+    return fileName.replace(/[^a-zA-Z0-9\-\\._]+/g, '_');


Quick comment before going through the full review, right now this has an extra \ before the . so wouldn't catch the right characters. Let's also remove the + here as noted in #14266 (comment)

Suggested change

return fileName.replace(/[^a-zA-Z0-9\-\\._]+/g, '_');

return fileName.replace(/[^a-zA-Z0-9\-\._]/g, '_');

@dangrous I added \\ to ignore the \ as well. But yeah it makes sense to remove that. I've updated the regex. Can you check now?

src/components/AttachmentPicker/index.js

mananjadhav · 2023-01-31T19:00:10Z

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 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 correct English and 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web-clean-file-name.mov

Mobile Web - Chrome

mweb-chrome-clean-file-name.mov

Mobile Web - Safari

mweb-safari-clean-file-name.mov

Desktop

desktop-clean-file-name.mov

iOS

ios-clean-file-name.mov

Android

android-clean-file-name.mov

@dangrous All yours. The change works fine. I've checked the : and / pattern. @akshayasalvi I couldn't download with / as well, but I think that should be fine as only iOS platforms allow file names with :.

dangrous

Hurray! Nice work.

OSBotify · 2023-01-31T21:08:56Z

✋ 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-02-02T00:45:06Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.2.64-0 🚀

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

OSBotify · 2023-02-04T00:18:17Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.64-7 🚀

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

OSBotify · 2023-02-04T01:56:18Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.64-7 🚀

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

OSBotify · 2023-02-04T02:02:25Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.64-7 🚀

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

fedirjh · 2023-07-24T14:25:06Z

src/components/AttachmentPicker/index.js

+                            if (file.name !== cleanName) {
+                                file = new File([file], cleanName);
+                            }


We should have included the filetype to prevent this bug . The bug arises after a backend change aimed at validating files by their types.

akshayasalvi added 5 commits January 26, 2023 06:24

added method to file utils for clean filename

ff3119b

use clean filename for web upload

8ca25fd

Merge branch 'main' of github.com:akshayasalvi/App into ak-replace-fi…

4015a62

…le-name-with-underscore

fixed error

223dfe9

fix native name

495c5dd

akshayasalvi requested a review from a team as a code owner January 30, 2023 20:12

melvin-bot bot requested review from dangrous and mananjadhav and removed request for a team January 30, 2023 20:12

dangrous reviewed Jan 30, 2023

View reviewed changes

akshayasalvi added 3 commits January 31, 2023 03:10

correct regex

a86aa99

fix lint issues

6ba344b

fix regex

e0e1dd4

dangrous reviewed Jan 31, 2023

View reviewed changes

src/components/AttachmentPicker/index.js Outdated Show resolved Hide resolved

akshayasalvi added 2 commits January 31, 2023 22:39

make copy file optional

db9a299

remove trailing space

a572080

mananjadhav approved these changes Jan 31, 2023

View reviewed changes

dangrous approved these changes Jan 31, 2023

View reviewed changes

dangrous merged commit 3a06fc5 into Expensify:main Jan 31, 2023

thienlnam mentioned this pull request Feb 2, 2023

Deploy Checklist: New Expensify 2023-02-02 #14771

Closed

30 tasks

Pujan92 mentioned this pull request Feb 3, 2023

[HOLD for payment 2023-02-13] [HOLD for payment 2023-02-10] [$1000] Profile : Infinite loading spinner appears choosing images with file names has space or special character #14757

Closed

6 tasks

melvin-bot bot mentioned this pull request Feb 3, 2023

[HOLD for payment 2023-02-10] File name with "/" removes the extension and breaks the file when downloaded #14266

Closed

6 tasks

bernhardoj mentioned this pull request Feb 12, 2023

[$2000] File upload in Safari: changing the filename in the filesystem changes what file is going to be uploaded #14654

Closed

6 tasks

stitesExpensify mentioned this pull request May 29, 2023

Chat - Non-Roman Alphabet file name of the Word document replaced with underscores in the chat #19616

Closed

6 tasks

fedirjh reviewed Jul 24, 2023

View reviewed changes

fedirjh mentioned this pull request Jul 24, 2023

[HOLD for payment 2023-07-24] [$1000] Unable to Upload PDF & JPEG files that contains a space in the file title #22219

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace file names with underscore when they have slash `/` #14664

Replace file names with underscore when they have slash `/` #14664

akshayasalvi commented Jan 30, 2023

melvin-bot bot commented Jan 30, 2023

akshayasalvi commented Jan 30, 2023

dangrous Jan 30, 2023

akshayasalvi Jan 30, 2023

mananjadhav commented Jan 31, 2023

dangrous left a comment

OSBotify commented Jan 31, 2023

OSBotify commented Feb 2, 2023

OSBotify commented Feb 4, 2023

OSBotify commented Feb 4, 2023

OSBotify commented Feb 4, 2023

fedirjh Jul 24, 2023

	return fileName.replace(/[^a-zA-Z0-9\-\\._]+/g, '_');
	return fileName.replace(/[^a-zA-Z0-9\-\._]/g, '_');

Replace file names with underscore when they have slash / #14664

Replace file names with underscore when they have slash / #14664

Conversation

akshayasalvi commented Jan 30, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 30, 2023

akshayasalvi commented Jan 30, 2023

dangrous Jan 30, 2023

Choose a reason for hiding this comment

akshayasalvi Jan 30, 2023

Choose a reason for hiding this comment

mananjadhav commented Jan 31, 2023

Reviewer Checklist

Screenshots/Videos

dangrous left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 31, 2023

OSBotify commented Feb 2, 2023

OSBotify commented Feb 4, 2023

OSBotify commented Feb 4, 2023

OSBotify commented Feb 4, 2023

fedirjh Jul 24, 2023

Choose a reason for hiding this comment

Replace file names with underscore when they have slash `/` #14664

Replace file names with underscore when they have slash `/` #14664