Handle potential CORS issues during file downloads by kidroca · Pull Request #25556 · Expensify/App

kidroca · 2023-08-21T08:23:46Z

Added logic to resolve URLs using tryResolveUrlFromApiRoot.
For URLs not originating from the API root (3rd party), leverage the browser's built-in functionality by opening them in a new tab to avoid CORS limitations during direct downloads.

Details

Given the security enhancements in browsers, they only permit the click() method on <a> elements with a 'download' attribute if invoked directly by user actions. The prior version of the function, which attempted to open it in new tab if the download failed fetched, sometimes led to a delayed user response, and the action was blocked.

Fixed Issues

$ #19965
PROPOSAL: #19965 (comment)
Also related: #23094 (comment)

Tests

Scenario 1 - Validate Concierge Drag & Drop Attachments

Objective: Ensure attachments added by Concierge through Drag & Drop are downloadable across platforms.

Prerequisites: A chat session with Concierge.

Steps:

General:
1. Initiate a chat with Concierge.
2. Request Concierge to send inline image attachments using the Drag & Drop method.
On Web / Desktop:
1. Click on any of the received attachments.
2. Click the Download button located in the upper right corner.
3. Note: Since the attachment is sourced directly from Amazon S3 (which is a different origin), it will not directly download but will open in a new browser tab/window.
~~On iOS / Android~~ (a regression prevents testing this flow in the current PR):
1. ~~Tap on any of the received attachments.~~
2. ~~Tap the Download button located in the upper right corner.~~
3. ~~Observation: Unlike web platforms, native apps are unaffected by CORS. As such, the attachment should download directly to the device.~~

Scenario 2 - Confirm Functionality of Regular Attachments

Objective: Ensure that attachments (excluding those from Concierge) are downloadable across all platforms.

Prerequisites: A chat session with an existing attachment (This could be any chat other than with Concierge).

Steps:

Navigate to a chat that contains an attachment. This can be an attachment sent by you or another party.
Open the attachment.
Click/Tap the Download button located in the upper right corner.
Observation: The attachment should initiate a direct download, saving it to your device or system.

Offline tests

N/A - attachments cannot be downloaded while offline

QA Steps

Scenario 1 - Validate Concierge Drag & Drop Attachments

Objective: Ensure attachments added by Concierge through Drag & Drop are downloadable across platforms.

Prerequisites: A chat session with Concierge.

Steps:

General:
1. Initiate a chat with Concierge.
2. Request Concierge to send inline image attachments using the Drag & Drop method.
On Web / Desktop:
1. Click on any of the received attachments.
2. Click the Download button located in the upper right corner.
3. Note: Since the attachment is sourced directly from Amazon S3 (which is a different origin), it will not directly download but will open in a new browser tab/window.
~~On iOS / Android~~ (a regression prevents testing this flow in the current PR):
1. ~~Tap on any of the received attachments.~~
2. ~~Tap the Download button located in the upper right corner.~~
3. ~~Observation: Unlike web platforms, native apps are unaffected by CORS. As such, the attachment should download directly to the device.~~

Scenario 2 - Confirm Functionality of Regular Attachments

Objective: Ensure that attachments (excluding those from Concierge) are downloadable across all platforms.

Prerequisites: A chat session with an existing attachment (This could be any chat other than with Concierge).

Steps:

Navigate to a chat that contains an attachment. This can be an attachment sent by you or another party.
Open the attachment.
Click/Tap the Download button located in the upper right corner.
Observation: The attachment should initiate a direct download, saving it to your device or system.

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-08-21.at.10.26.35.mov

Screen.Recording.2023-08-21.at.10.27.04.mov

Mobile Web - Chrome

Android.Emulator.-.Pixel_2_API_29_5554.2023-08-21.21-07-49.mp4

Android.Emulator.-.Pixel_2_API_29_5554.2023-08-21.21-08-24.mp4

Mobile Web - Safari

Screen.Recording.2023-08-21.at.10.16.04.mov

Screen.Recording.2023-08-21.at.10.16.41.mov

Desktop

Screen.Recording.2023-08-21.at.10.33.45.mov

Screen.Recording.2023-08-21.at.10.34.06.mov

iOS

Screen.Recording.2023-08-21.at.11.22.01.mov

Screen.Recording.2023-08-21.at.11.22.24.mov

Android

Screen_recording_20230901_192418.webm

Screen_recording_20230901_192618.webm

kidroca · 2023-08-21T10:11:58Z

The change here is related to: #23094 (comment)

Should we submit a separate PR
(If we do the current PR won't be testable on iOS and Android)

melvin-bot · 2023-08-22T07:58:36Z

@aimane-chnaif 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-09-01T16:28:45Z

Updated with latest changes from main

aimane-chnaif · 2023-10-22T19:46:11Z

@kidroca please fix these console errors

Screen.Recording.2023-10-22.at.8.45.02.PM.mov

I know this happens on main and not caused by this PR, but let's fix here. Otherwise it will remain forever. (no one will fix it)

kidroca · 2023-10-24T18:56:41Z

@aimane-chnaif

@kidroca please fix these console errors

I've added the following fix: da50bf4e (Also synced 3000+ commits from main)

aimane-chnaif · 2023-10-30T10:20:41Z

@kidroca conflicts. I will review today

- Added logic to resolve URLs using `tryResolveUrlFromApiRoot`. - For URLs not originating from the API root (3rd party), leverage the browser's built-in functionality by opening them in a new tab to avoid CORS limitations during direct downloads.

- Addressed issue where attachments, especially those added via drag and drop, lacked the `fileName` attribute, causing download failures. - Enhanced the fallback mechanism to generate file name from URL when `fileName` is missing. - Updated the fileName logic in `fileDownload` across iOS, Android, and web implementations.

kidroca · 2023-10-31T17:00:33Z

Conflicts resolved

aimane-chnaif · 2023-11-05T07:53: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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif · 2023-11-05T09:08:37Z

mSafari bug:

bug.mov

Seems related to carousel. Out of scope since already happening on main

aimane-chnaif · 2023-11-05T09:08:50Z

I am not able to download android file because of file name (i.e. 2023-11-05 07:55:06.813.jpg)

This happens because FileUtils.getAttachmentName doesn't have logic of replacing : with _ applied in FileUtils.appendTimeToFileName

android.download.mov

kidroca · 2023-11-06T09:55:59Z

I think we shouldn't have attempted to address the external regressions identified during testing, and that doing so caused significant delays to this PR.
To streamline the process, I'll be revert any fixes in this PR that aren't directly related to the issue at hand.

Let's acknowledge

the regressions around fileName handling aren't a result of the changes introduced in this PR.
We've identified and highlighted the root cause of the regression: [HOLD for payment 2023-08-10] [$1000] Android - User is able to click on download button on share code page after modal shows up if user is clicks rapidly and app crashes #23094 (comment)
you don't expect me to fix the regressions under the scope of the current ticket
you can hire me or anyone else to address the said regressions in a follow-up

This reverts commit 0060380. Revert "Fix: Add fallback name for attachments lacking the original filename" This reverts commit c1536f9.

aimane-chnaif · 2023-11-06T10:04:58Z

I agree ^.
@jasperhuangg can you please create new GH to fix external regressions not caused by this PR?
Given that this PR is too much delayed, I suggest to merge as is, as long as #19965 fix is done successfully.
And as we already have context, kindly assign @kidroca and me in new GH so we can work on new PR.

aimane-chnaif · 2023-11-06T10:09:46Z

Out of scope issues when file name doesn't exist:

cannot download
wrong attachment name (android only)
console error

OSBotify · 2023-11-06T22:54:03Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

aimane-chnaif · 2023-11-07T16:57:41Z

@kidroca I think we should not open new tab when download local image (blob). Let's fix that in new PR.

Screen.Recording.2023-11-07.at.5.52.58.PM.mov

kidroca · 2023-11-07T17:18:37Z

@kidroca I think we should not open new tab when download local image (blob). Let's fix that in new PR.

Thank you for the suggestion, @aimane-chnaif. I understand the scenario you're pointing out, but I believe it represents a very specific use case. The situation where a user tries to download an attachment they've just uploaded, before the upload process has completed is quite rare in typical user workflows.

Moreover, in the event that this does occur, it doesn't seem to cause any errors - the system handles it by re-rendering the attachment once the backend URL is ready, as in the video you've shared.

Given that this edge case neither breaks the app nor degrades the user experience significantly, adding extra logic to handle it might unnecessarily complicate handling. Complexity should only be introduced when it's clearly warranted, and in this instance, it seems like it would be for a relatively unlikely scenario.

That said, I'm open to hearing more about your concerns. If you feel there are additional factors I might not be considering, or if this is indicative of a larger issue, I'm definitely open to discussing it further.

aimane-chnaif · 2023-11-07T17:21:35Z

Agree it's edge case but it's a bit weird to show blob: in browser url

aimane-chnaif · 2023-11-07T17:21:52Z

Also, it doesn't work on desktop app

OSBotify · 2023-11-08T08:31:42Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.96-6 🚀

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

OSBotify · 2023-11-09T22:47:04Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T16:03:21Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:56:48Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

kidroca commented Aug 21, 2023

View reviewed changes

This was referenced Aug 21, 2023

Append current time to the downloaded file name #23531

Merged

[$1000] mWeb safari - attachments from Concierge don't download #19965

Closed

bernhardoj mentioned this pull request Aug 21, 2023

[HOLD for payment 2023-08-10] [$1000] Android - User is able to click on download button on share code page after modal shows up if user is clicks rapidly and app crashes #23094

Closed

6 tasks

kidroca marked this pull request as ready for review August 22, 2023 07:58

kidroca requested a review from a team as a code owner August 22, 2023 07:58

melvin-bot bot removed the request for review from a team August 22, 2023 07:58

melvin-bot bot requested a review from aimane-chnaif August 22, 2023 07:58

kidroca force-pushed the kidroca/fix/attachment-download-handle-cors-safari branch from 4fbbe80 to 2791cb1 Compare September 1, 2023 15:34

kidroca force-pushed the kidroca/fix/attachment-download-handle-cors-safari branch from 2791cb1 to 918c72f Compare October 5, 2023 19:10

kidroca force-pushed the kidroca/fix/attachment-download-handle-cors-safari branch 2 times, most recently from 565432c to da50bf4 Compare October 24, 2023 18:55

kidroca added 2 commits October 31, 2023 18:52

kidroca force-pushed the kidroca/fix/attachment-download-handle-cors-safari branch from da50bf4 to 55e5d64 Compare October 31, 2023 16:58

kidroca force-pushed the kidroca/fix/attachment-download-handle-cors-safari branch from 55e5d64 to 9324555 Compare November 1, 2023 09:31

kidroca added 2 commits November 1, 2023 11:38

Run prettier

2db8172

Fix: Add fallback name for attachments lacking the original filename

c1536f9

kidroca force-pushed the kidroca/fix/attachment-download-handle-cors-safari branch from 9324555 to c1536f9 Compare November 1, 2023 09:39

Revert "Fix: Handle undefined fileName during attachment download"

474ba31

This reverts commit 0060380. Revert "Fix: Add fallback name for attachments lacking the original filename" This reverts commit c1536f9.

aimane-chnaif approved these changes Nov 6, 2023

View reviewed changes

melvin-bot bot requested a review from jasperhuangg November 6, 2023 10:05

jasperhuangg approved these changes Nov 6, 2023

View reviewed changes

jasperhuangg merged commit d1bc5e9 into Expensify:main Nov 6, 2023

jasperhuangg mentioned this pull request Nov 6, 2023

[HOLD for payment 2023-12-15] [$500] Fix regressions related to file downloads #30931

Closed

kidroca deleted the kidroca/fix/attachment-download-handle-cors-safari branch November 7, 2023 15:01

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

dukenv0307 mentioned this pull request Nov 16, 2023

[Due payment][$500] IOU - Receipt image is not downloaded in offline mode. #31442

Closed

6 tasks

Conversation

kidroca commented Aug 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Scenario 1 - Validate Concierge Drag & Drop Attachments

Scenario 2 - Confirm Functionality of Regular Attachments

Offline tests

QA Steps

Scenario 1 - Validate Concierge Drag & Drop Attachments

Scenario 2 - Confirm Functionality of Regular Attachments

PR Author Checklist

Screenshots/Videos

Uh oh!

kidroca Aug 21, 2023

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Aug 22, 2023

Uh oh!

kidroca commented Sep 1, 2023

Uh oh!

aimane-chnaif commented Oct 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kidroca commented Oct 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aimane-chnaif commented Oct 30, 2023

Uh oh!

kidroca commented Oct 31, 2023

Uh oh!

aimane-chnaif commented Nov 5, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

aimane-chnaif commented Nov 5, 2023

Uh oh!

aimane-chnaif commented Nov 5, 2023

Uh oh!

kidroca commented Nov 6, 2023

Uh oh!

aimane-chnaif commented Nov 6, 2023

Uh oh!

aimane-chnaif commented Nov 6, 2023

Uh oh!

OSBotify commented Nov 6, 2023

Uh oh!

aimane-chnaif commented Nov 7, 2023

Uh oh!

kidroca commented Nov 7, 2023

Uh oh!

aimane-chnaif commented Nov 7, 2023

Uh oh!

aimane-chnaif commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Nov 8, 2023

Uh oh!

OSBotify commented Nov 9, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

OSBotify commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kidroca commented Aug 21, 2023 •

edited

Loading

aimane-chnaif commented Oct 22, 2023 •

edited

Loading

kidroca commented Oct 24, 2023 •

edited

Loading

aimane-chnaif commented Nov 7, 2023 •

edited

Loading