[Connect] Enable file downloads #4086
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ | |
| // Created by Mel Ludowise on 5/3/24. | ||
| // | ||
|
|
||
| import QuickLook | ||
| import SafariServices | ||
| @_spi(STP) import StripeCore | ||
| import WebKit | ||
|
|
@@ -14,11 +15,14 @@ import WebKit | |
| - Camera access | ||
| - Popup windows | ||
| - Opening email links | ||
| - Downloads | ||
| */ | ||
| @available(iOS 15, *) | ||
| class ConnectWebView: WKWebView { | ||
|
|
||
| /// File URL for a downloaded file | ||
| var downloadedFile: URL? | ||
|
|
||
|
Comment on lines
+23
to
+25
There was a problem hiding this comment. @mxl-stripe do we need to be robust to potentially handle multiple files that simultaneous download? The current design only stores one file at a time. If there's multiple downloads that occur simultaneously, we could get some unexpected behavior. If we need to, we could potentially handle multiple files, but it would take some effort. We'd have to effectively make a queue of downloaded files and wait for them to all finish before showing the preview. There was a problem hiding this comment. I don't think we should ever be triggering multiple downloads at the same time. Is it easy to detect if that is happening? I wonder if we could add a metric for that situation and monitor that it's zero. There was a problem hiding this comment. Yes, we should be able to add a metric for this – I added a comment to MXMOBILE-2491 so I remember to do that when adding analytics :-) |
||
| private var optionalPresentPopup: ((UIViewController) -> Void)? | ||
|
|
||
| /// Closure to present a popup web view controller. | ||
|
|
@@ -40,15 +44,20 @@ class ConnectWebView: WKWebView { | |
| /// The instance that will handle opening external urls | ||
| let urlOpener: ApplicationURLOpener | ||
|
|
||
| /// The file manager responsible for creating temporary file directories to store downloads | ||
| let fileManager: FileManager | ||
|
|
||
| /// The current version for the SDK | ||
| let sdkVersion: String? | ||
|
|
||
| init(frame: CGRect, | ||
| configuration: WKWebViewConfiguration, | ||
| // Only override for tests | ||
| urlOpener: ApplicationURLOpener = UIApplication.shared, | ||
| fileManager: FileManager = .default, | ||
| sdkVersion: String? = StripeAPIConfiguration.STPSDKVersion) { | ||
| self.urlOpener = urlOpener | ||
| self.fileManager = fileManager | ||
| self.sdkVersion = sdkVersion | ||
| configuration.applicationNameForUserAgent = "- stripe-ios/\(sdkVersion ?? "")" | ||
| super.init(frame: frame, configuration: configuration) | ||
|
|
@@ -101,6 +110,17 @@ private extension ConnectWebView { | |
| func openOnSystem(url: URL) { | ||
| urlOpener.openIfPossible(url) | ||
| } | ||
|
|
||
| func showErrorAlert(for error: Error) { | ||
| // TODO: MXMOBILE-2491 Log analytic when receiving an eror | ||
| debugPrint(error) | ||
|
|
||
| let alert = UIAlertController( | ||
| title: nil, | ||
| message: NSError.stp_unexpectedErrorMessage(), | ||
| preferredStyle: .alert) | ||
| presentPopup(alert) | ||
| } | ||
|
Comment on lines
+114
to
+123
There was a problem hiding this comment. Displays "There was an unexpected error -- try again in a few seconds" |
||
| } | ||
|
|
||
| // MARK: - WKUIDelegate | ||
|
|
@@ -158,27 +178,128 @@ extension ConnectWebView: WKNavigationDelegate { | |
| _ webView: WKWebView, | ||
| decidePolicyFor navigationAction: WKNavigationAction | ||
| ) async -> WKNavigationActionPolicy { | ||
| /* | ||
| `shouldPerformDownload` will be true if the request has MIME types | ||
| or a `Content-Type` header indicating it's a download or it originated | ||
| as a JS download. | ||
|
|
||
| NOTE: We sometimes can't know if a request should be a download until | ||
| after its response is received. Those cases are handled by | ||
| `decidePolicyFor navigationResponse` below. | ||
| */ | ||
| navigationAction.shouldPerformDownload ? .download : .allow | ||
| } | ||
|
|
||
| func webView( | ||
| _ webView: WKWebView, | ||
| decidePolicyFor navigationResponse: WKNavigationResponse | ||
| ) async -> WKNavigationResponsePolicy { | ||
|
|
||
| // Downloads will typically originate from a non-allow-listed host (e.g. S3) | ||
| // so first check if the response is a download before evaluating the host | ||
|
|
||
| // The response should be a download if its Content-Disposition is | ||
| // shaped like `attachment; filename=payouts.csv` | ||
| if navigationResponse.canShowMIMEType, | ||
| let response = navigationResponse.response as? HTTPURLResponse, | ||
| let contentDisposition = response.value(forHTTPHeaderField: "Content-Disposition"), | ||
| contentDisposition | ||
| .split(separator: ";") | ||
| .map({ $0.trimmingCharacters(in: .whitespaces) }) | ||
| .caseInsensitiveContains("attachment") { | ||
| return .download | ||
| } | ||
|
|
||
| return .allow | ||
| } | ||
|
|
||
| func webView(_ webView: WKWebView, | ||
| navigationAction: WKNavigationAction, | ||
| didBecome download: WKDownload) { | ||
| download.delegate = self | ||
| } | ||
|
|
||
| func webView(_ webView: WKWebView, | ||
| navigationResponse: WKNavigationResponse, | ||
| didBecome download: WKDownload) { | ||
| download.delegate = self | ||
| } | ||
| } | ||
|
|
||
| // MARK: - WKDownloadDelegate implementation | ||
|
|
||
| @available(iOS 15, *) | ||
| extension ConnectWebView { | ||
| // This extension is an abstraction layer to implement `WKDownloadDelegate` | ||
| // functionality and make it testable. There's no way to instantiate | ||
| // `WKDownload` in tests without causing an EXC_BAD_ACCESS error. | ||
|
|
||
| func download(decideDestinationUsing response: URLResponse, | ||
| suggestedFilename: String) async -> URL? { | ||
| // The temporary filename must be unique or the download will fail. | ||
| // To ensure uniqueness, append a UUID to the directory path in case a | ||
| // file with the same name was already downloaded from this app. | ||
| let tempDir = fileManager | ||
| .temporaryDirectory | ||
| .appendingPathComponent(UUID().uuidString) | ||
| do { | ||
| try fileManager.createDirectory(at: tempDir, withIntermediateDirectories: true) | ||
| } catch { | ||
| showErrorAlert(for: error) | ||
| return nil | ||
| } | ||
|
|
||
| downloadedFile = tempDir.appendingPathComponent(suggestedFilename) | ||
| return downloadedFile | ||
| } | ||
|
|
||
| func download(didFailWithError error: any Error, | ||
| resumeData: Data?) { | ||
| showErrorAlert(for: error) | ||
| } | ||
|
|
||
| func downloadDidFinish() { | ||
|
|
||
| // Display a preview of the file to the user | ||
| let previewController = QLPreviewController() | ||
| previewController.dataSource = self | ||
| previewController.modalPresentationStyle = .pageSheet | ||
| presentPopup(previewController) | ||
|
Comment on lines
+263
to
+267
There was a problem hiding this comment. Would we want to just present the share sheet directly here rather than having to fix potential bugs involving previewing certain file types? There was a problem hiding this comment. We could – let me get feedback from the team what the preference is. There was a problem hiding this comment. Looks like we can check if the file is previewable, and if it's not then directly open the share sheet. Really good call out – from the docs:
There was a problem hiding this comment. I'm going to merge this but do a fast-follow PR to address this issue There was a problem hiding this comment. |
||
| } | ||
| } | ||
|
|
||
| // MARK: - WKDownloadDelegate | ||
|
|
||
| @available(iOS 15, *) | ||
| extension ConnectWebView: WKDownloadDelegate { | ||
| func download(_ download: WKDownload, | ||
| decideDestinationUsing response: URLResponse, | ||
| suggestedFilename: String) async -> URL? { | ||
| await self.download(decideDestinationUsing: response, | ||
| suggestedFilename: suggestedFilename) | ||
| } | ||
|
|
||
| func download(_ download: WKDownload, | ||
| didFailWithError error: any Error, | ||
| resumeData: Data?) { | ||
| self.download(didFailWithError: error, resumeData: resumeData) | ||
| } | ||
|
|
||
| func downloadDidFinish(_ download: WKDownload) { | ||
| self.downloadDidFinish() | ||
| } | ||
| } | ||
|
|
||
| // MARK: - QLPreviewControllerDataSource | ||
|
|
||
| @available(iOS 15, *) | ||
| extension ConnectWebView: QLPreviewControllerDataSource { | ||
| func numberOfPreviewItems(in controller: QLPreviewController) -> Int { | ||
| downloadedFile == nil ? 0 : 1 | ||
| } | ||
|
|
||
| func previewController(_ controller: QLPreviewController, previewItemAt index: Int) -> any QLPreviewItem { | ||
| // Okay to force-unwrap since numberOfPreviewItems returns 0 when downloadFile is nil | ||
| downloadedFile! as QLPreviewItem | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Lets us test the SDK on iOS 15 devices