-
Notifications
You must be signed in to change notification settings - Fork 2.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Append current time to the downloaded file name #23531
Append current time to the downloaded file name #23531
Conversation
@parasharrajat 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] |
@@ -104,7 +104,7 @@ function getFileType(fileUrl) { | |||
function splitExtensionFromFileName(fullFileName) { | |||
const fileName = fullFileName.trim(); | |||
const splitFileName = fileName.split('.'); | |||
const fileExtension = splitFileName.pop(); | |||
const fileExtension = splitFileName.length > 1 ? splitFileName.pop() : ''; | |||
return {fileName: splitFileName.join('.'), fileExtension}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change is to fix the file name that is returned as the extension when the file name does not have an extension, for example, if the file name is anyfilename
, the fileExtension
is anyfilename
and the fileName
is empty.
This function is being used for attachment validation. Before this change, we can upload a file name jpg
because jpg
is a valid extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lovely. Thanks.
@@ -41,7 +41,7 @@ function handleDownload(url, fileName) { | |||
|
|||
// Android files will download to Download directory | |||
const path = dirs.DownloadDir; | |||
const attachmentName = fileName || FileUtils.getAttachmentName(url); | |||
const attachmentName = FileUtils.appendTimeToFileName(fileName) || FileUtils.getAttachmentName(url); | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the fileName
is empty (idk when this case could happen), it will generate the file name from the url
. FileUtils.getAttachmentName
itself appends the current time to the generated file name with a different format, that's why I append the time to fileName
only.
App/src/libs/fileDownload/FileUtils.js
Lines 56 to 61 in ecf0ec2
function getAttachmentName(url) { | |
if (!url) { | |
return ''; | |
} | |
return `${moment().format('DDMMYYYYHHmmss')}.${url.split(/[#?]/)[0].split('.').pop().trim()}`; | |
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's follow the same pattern for date.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
which one to follow, the format from getAttachmentName
or the new one I created?
getAttachmentName
: 24102000163544.[extension],
if we follow the new one, this becomes 2023-07-26T03:58:14.737Z.[extension]
new: [name] - 2023-07-26T03:58:14.737Z.[extension],
if we follow the above, this becomes [name] - 24102000163544.[extension]
Also, I don't found any case for getAttachmentName
yet, so we can't test its usage.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say let's do the old one (24102000163544). But I don't have any preference. Both works. Feel free to use the one that look best to you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I decided to use the date format from DateUtils.getDBTime()
. It is the same with the new format, except T is replaced with space and Z is removed. The old format does not have milliseconds which I think is really important to keep it.
On iOS, we can't append the current time to the image name. That is because we are using the CameraRoll library to save it and it doesn't have the option to set a name. App/src/libs/fileDownload/index.ios.js Lines 38 to 40 in ecf0ec2
This is how the downloaded image (from iOS) name looks like. So, only the iOS image doesn't have the current time appended to its name, but the other platforms should have it (including iOS mWeb). |
Added a unit test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should rename
to getAttachmentDetails
because there are two functions with same name.
Does this not exist on iOS? |
Renamed
Only for image. CameraRoll library does not have any option to set a custom name when saving it. We just give the CameraRoll the image URL and it will generate the name by itself.
We actually use CameraRoll for saving video too, the difference is, for video, we first download it with App/src/libs/fileDownload/index.ios.js Lines 53 to 54 in 0fec944
The video URI looks like this:
I guess that when we pass a URI, CameraRoll will just use its name from the URI. |
So Won't it create the same crash issue for iOS? Or it works/handled there. |
@parasharrajat I don't know whether iOS has the same limitation, but even if it has, it won't ever happen as the generated image name contains an incremental(?) number, for example, IMG_001, IMG_002, so the name will always be unique. |
src/libs/fileDownload/FileUtils.js
Outdated
*/ | ||
function appendTimeToFileName(fileName) { | ||
const file = splitExtensionFromFileName(fileName); | ||
let newFileName = `${file.fileName} - ${DateUtils.getDBTime()}`; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let newFileName = `${file.fileName} - ${DateUtils.getDBTime()}`; | |
let newFileName = `${file.fileName}-${DateUtils.getDBTime()}`; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
A small request above @bernhardoj. |
Screenshots🔲 iOS / nativeScreen.Recording.2023-07-28.at.12.53.00.AM.mov🔲 iOS / SafariScreen.Recording.2023-07-28.at.12.54.07.AM.mov🔲 MacOS / DesktopScreen.Recording.2023-07-28.at.12.49.57.AM.mov🔲 MacOS / ChromeScreen.Recording.2023-07-28.at.12.49.26.AM.mov🔲 Android / ChromeScreen.Recording.2023-07-28.at.12.51.01.AM.mov🔲 Android / nativeScreen.Recording.2023-07-28.at.12.56.10.AM.mov |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 verified the steps for local testing are in the
- 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 notonIconClick
). - 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
- 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.
- 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 usingAvatar
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. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor) - Any internal methods bound to
this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
) - 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 thatAvatar
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 theTest
steps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
I have requested a small change above but approved it as that change won't make a real difference to the functionality. |
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.49-0 🚀
|
🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.50-0 🚀
|
🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀
|
🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀
|
const attachmentName = fileName || FileUtils.getAttachmentName(url); | ||
const attachmentName = FileUtils.appendTimeToFileName(fileName) || FileUtils.getAttachmentName(url); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current logic for determining attachmentName
doesn't adequately handle fallback scenarios:
const attachmentName = FileUtils.appendTimeToFileName(fileName) || FileUtils.getAttachmentName(url);
- If
fileName
isundefined
, the application will throw an error due to the attempt to append time to it, leading to a failed download. FileUtils.appendTimeToFileName
always returns a value, so we won't ever fall back toFileUtils.getAttachmentName
, even in cases wherefileName
is an empty string.
The previous version of the function handled both of these cases
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right. I think we should do
const attachmentName = fileName ? FileUtils.appendTimeToFileName(fileName) : FileUtils.getAttachmentName(url);
instead. Or should appendTimeToFileName
handle the empty (undefined, null, empty string) case?
Btw, are you coming from an issue that is caused by this change? I'm curious to know in what case the fileName
is empty. If not, what should I do here? Should I open a PR?
cc: @parasharrajat
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've stumbled on the problem, when I was testing my PR on iOS: #25556
I've already included a fix in my PR
It seems fileName
can be undefined for attachments that are send by Concierge, when they embed images via Drag & Drop
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. Thanks @kidroca for handling that. Let's know if you want any refactors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems fileName can be undefined for attachments that are send by Concierge, when they embed images via Drag & Drop
I see. What a unique case. Thanks for catching and handling it!
Details
We want to append the current time to every file downloaded on the App. This is to make every file downloaded has a unique name.
Fixed Issues
$ #23094
PROPOSAL: #23094 (comment)
Tests
Same as QA Steps
Offline tests
Requires internet connection to download
QA Steps
Only available on iOS/Android
2FA code download
Chat attachment download
To see the file downloaded:
For mWeb/Web, open your Downloads folder
For Android, go to File Manager > Downloads > Expensify
For iOS:
PR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)myBool && <MyComponent />
.src/languages/*
files and using the translation methodWaiting for Copy
label for a copy review on the original GH to get the correct copy.STYLE.md
) were followedAvatar
, I verified the components usingAvatar
are working as expected)/** comment above it */
this
properly so there are no scoping issues (i.e. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor)this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
)Avatar
is modified, I verified thatAvatar
is working as expected in all cases)ScrollView
component to make it scrollable when more elements are added to the page.main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps.Screenshots/Videos
Web
web.mov
Mobile Web - Chrome
Screenrecorder-2023-07-25-16-51-03-773.mp4
Screenrecorder-2023-07-25-16-50-10-33.mp4
Mobile Web - Safari
ios_mweb.mov
Desktop
desktop.mov
iOS
ios.mov
ios_2fa.mov
ios_others.mov
Android
Screenrecorder-2023-07-25-16-32-50-528.mp4
Screenrecorder-2023-07-25-16-42-29-345.mp4
Screenrecorder-2023-07-25-16-40-33-602.mp4