From e4ad169d71c94a7382f801a4f3d8e455843aa81f Mon Sep 17 00:00:00 2001 From: Michael Kirk Date: Thu, 19 Oct 2017 14:46:50 -0700 Subject: [PATCH] Show retryable error alert when fetching GIF fails // FREEBIE --- Signal/src/UserInterface/Strings.swift | 2 +- .../FingerprintViewScanController.m | 13 +++++-------- .../GifPicker/GifPickerCell.swift | 10 +++------- .../GifPicker/GifPickerViewController.swift | 17 +++++++++++++++++ .../OWSLinkDeviceViewController.m | 2 +- .../OWSLinkedDevicesTableViewController.m | 6 ++---- Signal/src/network/GiphyAPI.swift | 15 +++++++++++++++ .../translations/en.lproj/Localizable.strings | 11 ++++++++++- 8 files changed, 54 insertions(+), 22 deletions(-) diff --git a/Signal/src/UserInterface/Strings.swift b/Signal/src/UserInterface/Strings.swift index e62c9d8e4..4624f5bc0 100644 --- a/Signal/src/UserInterface/Strings.swift +++ b/Signal/src/UserInterface/Strings.swift @@ -11,7 +11,7 @@ import Foundation @objc class CommonStrings: NSObject { static let dismissButton = NSLocalizedString("DISMISS_BUTTON_TEXT", comment: "Short text to dismiss current modal / actionsheet / screen") static let cancelButton = NSLocalizedString("TXT_CANCEL_TITLE", comment:"Label for the cancel button in an alert or action sheet.") - + static let retryButton = NSLocalizedString("RETRY_BUTTON_TEXT", comment:"Generic text for button that retries whatever the last action was.") } @objc class MessageStrings: NSObject { diff --git a/Signal/src/ViewControllers/FingerprintViewScanController.m b/Signal/src/ViewControllers/FingerprintViewScanController.m index c289c88ef..8bd3d44b3 100644 --- a/Signal/src/ViewControllers/FingerprintViewScanController.m +++ b/Signal/src/ViewControllers/FingerprintViewScanController.m @@ -239,14 +239,11 @@ NS_ASSUME_NONNULL_BEGIN preferredStyle:UIAlertControllerStyleAlert]; if (retryBlock) { - [alertController - addAction:[UIAlertAction - actionWithTitle:NSLocalizedString(@"RETRY_BUTTON_TEXT", - @"Generic text for button that retries whatever the last action was.") - style:UIAlertActionStyleDefault - handler:^(UIAlertAction *action) { - retryBlock(); - }]]; + [alertController addAction:[UIAlertAction actionWithTitle:[CommonStrings retryButton] + style:UIAlertActionStyleDefault + handler:^(UIAlertAction *action) { + retryBlock(); + }]]; } [alertController addAction:[OWSAlerts cancelAction]]; diff --git a/Signal/src/ViewControllers/GifPicker/GifPickerCell.swift b/Signal/src/ViewControllers/GifPicker/GifPickerCell.swift index 8bced63b0..96bda3f3d 100644 --- a/Signal/src/ViewControllers/GifPicker/GifPickerCell.swift +++ b/Signal/src/ViewControllers/GifPicker/GifPickerCell.swift @@ -9,10 +9,6 @@ class GifPickerCell: UICollectionViewCell { let TAG = "[GifPickerCell]" // MARK: Properties - enum GifPickerCellError: Error { - case assertionError(description: String) - case fetchFailure - } var imageInfo: GiphyImageInfo? { didSet { @@ -211,7 +207,7 @@ class GifPickerCell: UICollectionViewCell { public func requestRenditionForSending() -> Promise { guard let renditionForSending = self.renditionForSending else { owsFail("\(TAG) renditionForSending was unexpectedly nil") - return Promise(error: GifPickerCellError.assertionError(description: "renditionForSending was unexpectedly nil")) + return Promise(error: GiphyError.assertionError(description: "renditionForSending was unexpectedly nil")) } let (promise, fulfill, reject) = Promise.pending() @@ -227,8 +223,8 @@ class GifPickerCell: UICollectionViewCell { failure: { _ in // TODO GiphyDownloader API shoudl pass through a useful failing error // so we can pass it through here - reject(GifPickerCellError.fetchFailure) - + Logger.error("\(self.TAG) request failed") + reject(GiphyError.fetchFailure) }) return promise diff --git a/Signal/src/ViewControllers/GifPicker/GifPickerViewController.swift b/Signal/src/ViewControllers/GifPicker/GifPickerViewController.swift index d7e8c4345..5b3afce68 100644 --- a/Signal/src/ViewControllers/GifPicker/GifPickerViewController.swift +++ b/Signal/src/ViewControllers/GifPicker/GifPickerViewController.swift @@ -333,6 +333,10 @@ class GifPickerViewController: OWSViewController, UISearchBarDelegate, UICollect self.collectionView.isUserInteractionEnabled = false + getFileForCell(cell) + } + + public func getFileForCell(_ cell: GifPickerCell) { GiphyDownloader.sharedInstance.cancelAllRequests() cell.requestRenditionForSending().then { (asset: GiphyAsset) -> Void in let filePath = asset.filePath @@ -349,7 +353,20 @@ class GifPickerViewController: OWSViewController, UISearchBarDelegate, UICollect self.delegate?.gifPickerDidSend(outgoingMessage: outgoingMessage) self.dismiss(animated: true, completion: nil) + }.catch { error in + let alert = UIAlertController(title: NSLocalizedString("GIF_PICKER_FAILURE_ALERT_TITLE", comment: "Shown when selected gif couldn't be fetched"), + message: error.localizedDescription, + preferredStyle: .alert) + alert.addAction(UIAlertAction(title: CommonStrings.retryButton, style: .default) { _ in + self.getFileForCell(cell) + }) + alert.addAction(UIAlertAction(title: CommonStrings.dismissButton, style: .cancel) { _ in + self.dismiss(animated: true, completion: nil) + }) + + UIApplication.shared.frontmostViewController?.present(alert, animated: true, completion: nil) }.retainUntilComplete() + } public func collectionView(_ collectionView: UICollectionView, willDisplay cell: UICollectionViewCell, forItemAt indexPath: IndexPath) { diff --git a/Signal/src/ViewControllers/OWSLinkDeviceViewController.m b/Signal/src/ViewControllers/OWSLinkDeviceViewController.m index 20f9242cf..cf17c26e7 100644 --- a/Signal/src/ViewControllers/OWSLinkDeviceViewController.m +++ b/Signal/src/ViewControllers/OWSLinkDeviceViewController.m @@ -185,7 +185,7 @@ NS_ASSUME_NONNULL_BEGIN message:error.localizedDescription preferredStyle:UIAlertControllerStyleAlert]; - UIAlertAction *retryAction = [UIAlertAction actionWithTitle:NSLocalizedString(@"RETRY_BUTTON_TEXT", nil) + UIAlertAction *retryAction = [UIAlertAction actionWithTitle:[CommonStrings retryButton] style:UIAlertActionStyleDefault handler:^(UIAlertAction *action) { retryBlock(); diff --git a/Signal/src/ViewControllers/OWSLinkedDevicesTableViewController.m b/Signal/src/ViewControllers/OWSLinkedDevicesTableViewController.m index 6106886c4..413a3b3d0 100644 --- a/Signal/src/ViewControllers/OWSLinkedDevicesTableViewController.m +++ b/Signal/src/ViewControllers/OWSLinkedDevicesTableViewController.m @@ -158,9 +158,7 @@ int const OWSLinkedDevicesTableViewControllerSectionAddDevice = 1; message:error.localizedDescription preferredStyle:UIAlertControllerStyleAlert]; - NSString *retryTitle = NSLocalizedString( - @"RETRY_BUTTON_TEXT", @"Generic text for button that retries whatever the last action was."); - UIAlertAction *retryAction = [UIAlertAction actionWithTitle:retryTitle + UIAlertAction *retryAction = [UIAlertAction actionWithTitle:[CommonStrings retryButton] style:UIAlertActionStyleDefault handler:^(UIAlertAction *action) { [wself refreshDevices]; @@ -368,7 +366,7 @@ int const OWSLinkedDevicesTableViewControllerSectionAddDevice = 1; preferredStyle:UIAlertControllerStyleAlert]; UIAlertAction *retryAction = - [UIAlertAction actionWithTitle:NSLocalizedString(@"RETRY_BUTTON_TEXT", nil) + [UIAlertAction actionWithTitle:[CommonStrings retryButton] style:UIAlertActionStyleDefault handler:^(UIAlertAction *aaction) { [self unlinkDevice:device success:successCallback]; diff --git a/Signal/src/network/GiphyAPI.swift b/Signal/src/network/GiphyAPI.swift index 351fae073..3ed03c897 100644 --- a/Signal/src/network/GiphyAPI.swift +++ b/Signal/src/network/GiphyAPI.swift @@ -9,6 +9,21 @@ enum GiphyFormat { case gif, mp4, jpg } +enum GiphyError: Error { + case assertionError(description: String) + case fetchFailure +} +extension GiphyError: LocalizedError { + public var errorDescription: String? { + switch self { + case .assertionError: + return NSLocalizedString("GIF_PICKER_ERROR_GENERIC", comment: "Generic error displayed when picking a gif") + case .fetchFailure: + return NSLocalizedString("GIF_PICKER_ERROR_FETCH_FAILURE", comment: "Error displayed when there is a failure fetching gifs from the remote service.") + } + } +} + // Represents a "rendition" of a GIF. // Giphy offers a plethora of renditions for each image. // They vary in content size (i.e. width, height), diff --git a/Signal/translations/en.lproj/Localizable.strings b/Signal/translations/en.lproj/Localizable.strings index 902a3a17c..fe45f632f 100644 --- a/Signal/translations/en.lproj/Localizable.strings +++ b/Signal/translations/en.lproj/Localizable.strings @@ -613,6 +613,15 @@ /* A label for generic attachments. */ "GENERIC_ATTACHMENT_LABEL" = "Attachment"; +/* Error displayed when there is a failure fetching gifs from the remote service. */ +"GIF_PICKER_ERROR_FETCH_FAILURE" = "Failed to fetch the requested GIF. Please verify you are online."; + +/* Generic error displayed when picking a gif */ +"GIF_PICKER_ERROR_GENERIC" = "An unknown error occured."; + +/* Shown when selected gif couldn't be fetched */ +"GIF_PICKER_FAILURE_ALERT_TITLE" = "Unable to Choose GIF"; + /* Alert message shown when user tries to search for GIFs without entering any search terms. */ "GIF_PICKER_VIEW_MISSING_QUERY" = "Please enter your search."; @@ -985,7 +994,7 @@ /* The title for the 'create group' button. */ "NEW_GROUP_CREATE_BUTTON" = "Create"; -/* The navbar title for the 'new group' view. */ +/* Used in place of the group name when a group has not yet been named. */ "NEW_GROUP_DEFAULT_TITLE" = "New Group"; /* An indicator that a user is a member of the new group. */